cancel(projectId, jobId, location=None, x__xgafv=None)

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.

Args:
projectId: string, Required. Project ID of the job to cancel (required)
jobId: string, Required. Job ID of the job to cancel (required)
location: string, The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Describes format of a jobs cancellation response.
"job": { # The final state of the job.
"configuration": { # Required. Describes the job configuration.
"copy": { # 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). # [Pick one] Copies a table.
"createDisposition": "A 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": { # Custom encryption configuration (e.g., Cloud KMS keys).
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationExpirationTime": "A String", # Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
"destinationTable": { # [Required] The destination table.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Optional. Supported operation types in table copy job.
"sourceTable": { # [Pick one] Source table to copy.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # [Pick one] Source tables to copy.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A 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": True or False, # 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 configures a job that exports data from a BigQuery table into Google Cloud Storage. # [Pick one] Configures an extract job.
"compression": "A 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": "A 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": "A 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": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
"A String",
],
"fieldDelimiter": "A 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": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models.
"trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.
},
"printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
"sourceModel": { # Id path of a model. # A reference to the model being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this model.
"modelId": "A 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": "A String", # Required. The ID of the project containing this model.
},
"sourceTable": { # A reference to the table being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.
},
"jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.
"jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
"labels": { # 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.
"a_key": "A String",
},
"load": { # JobConfigurationLoad contains the configuration properties for loading data into a destination table. # [Pick one] Configures a load job.
"allowJaggedRows": True or False, # 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": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"autodetect": True or False, # Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"clustering": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # 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.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to only copy files to the destination BigLake managed table with an external storage_uri, without reading file content and writing them to new files. Copying files only is supported when: * source_uris are in the same external storage system as the destination table but they do not overlap with storage_uri of the destination table. * source_format is the same file format as the destination table. * destination_table is an existing BigLake managed table. Its schema does not have default value expression. It schema does not have type parameters other than precision and scale. * No options other than the above are specified.
"createDisposition": "A 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": True or False, # 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.
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # [Required] The destination table to load the data into.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Properties for the destination table. # Optional. [Experimental] Properties with which to create the destination table if it is new.
"description": "A 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": "A String", # Internal use only.
"friendlyName": "A String", # Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.
"labels": { # 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.
"a_key": "A String",
},
},
"encoding": "A 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": "A 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": "A String", # 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": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.
"jsonExtension": "A String", # 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": 42, # 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": "A 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.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"preserveAsciiControlCharacters": True or False, # 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": [ # 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.
"A String",
],
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"referenceFileSchemaUri": "A 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": { # Schema of a table # Optional. The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaUpdateOptions": [ # 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 two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"skipLeadingRows": 42, # 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.
"sourceFormat": "A 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": [ # [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.
"A String",
],
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useAvroLogicalTypes": True or False, # 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": "A 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_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.
},
"query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job.
"allowLargeResults": false, # 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": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # Connection properties which can modify the query behavior.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"continuous": True or False, # [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
"createDisposition": "A 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": True or False, # 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": { # Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable `@@dataset_id` achieves the same behavior. See https://cloud.google.com/bigquery/docs/reference/system-variables for more information on system variables.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": true, # 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": 1, # 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": "A String", # 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": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
"priority": "A String", # Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.
"queryParameters": [ # Query parameters for GoogleSQL queries.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts.
"keyResultStatement": "A String", # 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": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error.
"statementTimeoutMs": "A String", # Timeout period for each statement in a script.
},
"systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables.
"types": { # Output only. Data type for each system variable.
"a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } }
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE".
"structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [ # Fields within the struct.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
},
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
"values": { # Output only. Value for each system variable.
"a_key": "", # Properties of the object.
},
},
"tableDefinitions": { # 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.
"a_key": {
"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"avroOptions": { # Options for external data sources. # Optional. Additional properties to set if sourceFormat is set to AVRO.
"useAvroLogicalTypes": True or False, # 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).
},
"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE.
"columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
{ # Information related to a Bigtable column family.
"columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
{ # Information related to a Bigtable column.
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
"fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.
"onlyReadLatest": True or False, # Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.
"qualifierString": "A String", # Qualifier string.
"type": "A String", # Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
},
],
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
"familyId": "A String", # Identifier of the column family.
"onlyReadLatest": True or False, # Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
"type": "A String", # Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
},
],
"ignoreUnspecifiedColumnFamilies": True or False, # Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
"outputColumnFamiliesAsJson": True or False, # Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
"readRowkeyAsString": True or False, # Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
},
"compression": "A String", # Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.
"connectionId": "A String", # Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form "<project\_id>.<location\_id>.<connection\_id>" or "projects/<project\_id>/locations/<location\_id>/connections/<connection\_id>".
"csvOptions": { # Information related to a CSV data source. # Optional. Additional properties to set if sourceFormat is set to CSV.
"allowJaggedRows": True or False, # Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
"allowQuotedNewlines": True or False, # Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"encoding": "A 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.
"fieldDelimiter": "A 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).
"nullMarker": "A String", # [Optional] A custom string that will represent a NULL value in CSV import data.
"preserveAsciiControlCharacters": True or False, # Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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 ' "" '.
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
"googleSheetsOptions": { # Options specific to Google Sheets data sources. # Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
"range": "A String", # Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, 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.
},
"hivePartitioningOptions": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.
"jsonExtension": "A String", # 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).
"jsonOptions": { # Json Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to JSON.
"encoding": "A String", # Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
},
"maxBadRecords": 42, # Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.
"metadataCacheMode": "A String", # Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
"objectMetadata": "A String", # Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
"schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
"A String",
],
},
},
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useLegacySql": true, # Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
"useQueryCache": true, # 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": [ # Describes user-defined function resources used in the query.
{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
},
],
"writeDisposition": "A 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_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.
},
},
"etag": "A String", # Output only. A hash of this resource.
"id": "A String", # Output only. Opaque ID field of the job.
"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`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
"code": "A String", # Output only. Specifies the high level reason why a Job was created.
},
"jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job.
"jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
},
"kind": "bigquery#job", # Output only. The type of the resource.
"principal_subject": "A 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": "A String", # Output only. A URL that can be used to access the resource again.
"statistics": { # Statistics for a single job execution. # Output only. Information about the job, including starting time and ending time of the job.
"completionRatio": 3.14, # Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job.
"copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table.
"copiedRows": "A String", # Output only. Number of rows copied to the destination table.
},
"creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
"endTime": "A String", # 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": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # 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.
"A String",
],
"inputBytes": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"finalExecutionDurationMs": "A String", # 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.
"load": { # Statistics for a load job. # Output only. Statistics for a load job.
"badRecords": "A String", # 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": "A String", # Output only. Number of bytes of source data in a load job.
"inputFiles": "A String", # Output only. Number of source files in a load job.
"outputBytes": "A String", # 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": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"numChildJobs": "A String", # Output only. Number of child jobs executed.
"parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent.
"query": { # Statistics for a query job. # Output only. Statistics for a query job.
"biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics.
"accelerationMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineReasons": [ # 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.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
},
"billingTier": 42, # 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": True or False, # Output only. Whether the query result was fetched from the query cache.
"dclTargetDataset": { # Output only. Referenced dataset for DCL statement.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"dclTargetTable": { # Output only. Referenced table for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Output only. Referenced view for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
"ddlDestinationTable": { # Output only. The table after rename. Present only for ALTER TABLE RENAME TO query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
"ddlTargetDataset": { # Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"ddlTargetRoutine": { # Id path of a routine. # Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
"ddlTargetRowAccessPolicy": { # Id path of a row access policy. # Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
"datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
"policyId": "A 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": "A String", # Required. The ID of the project containing this row access policy.
"tableId": "A String", # Required. The ID of the table containing this row access policy.
},
"ddlTargetTable": { # Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
"deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
"insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
"updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.
},
"estimatedBytesProcessed": "A String", # Output only. The original estimate of bytes processed for the job.
"exportDataStatistics": { # Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. # Output only. Stats for EXPORT DATA statement.
"fileCount": "A String", # Number of destination files generated in case of EXPORT DATA statement only.
"rowCount": "A String", # [Alpha] Number of destination rows generated in case of EXPORT DATA statement only.
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
"reservedSlotCount": "A String", # 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": "A String", # External service cost in terms of bigquery slot milliseconds.
},
],
"loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query.
"badRecords": "A String", # 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": "A String", # 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": "A String", # Output only. Number of bytes of source data in a LOAD query.
"inputFiles": "A String", # Output only. Number of source files in a LOAD query.
"outputBytes": "A String", # 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": "A String", # 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": { # Statistics of materialized views considered in a query job. # Output only. Statistics of materialized views of a query job.
"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.
{ # A materialized view considered for a query job.
"chosen": True or False, # 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": "A String", # If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.
"rejectedReason": "A String", # If present, specifies the reason why the materialized view was not chosen for the query.
"tableReference": { # The candidate materialized view.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
},
],
},
"metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables.
"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query.
{ # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.
"explanation": "A String", # Free form human-readable reason metadata caching was unused for the job.
"tableReference": { # Metadata caching eligible table referenced in the query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"tableType": "A String", # [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).
"unusedReason": "A String", # Reason for not using metadata caching for the table.
},
],
},
"mlStatistics": { # Job statistics specific to a BigQuery ML training job. # Output only. Statistics of a BigQuery ML training job.
"hparamTrials": [ # Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
{ # Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.
"endTimeMs": "A String", # Ending time of the trial.
"errorMessage": "A String", # Error message for FAILED and INFEASIBLE trial.
"evalLoss": 3.14, # Loss computed on the eval data at the end of trial.
"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. # Evaluation metrics of this trial calculated on the test data. Empty in Job API.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparamTuningEvaluationMetrics": { # 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. # Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparams": { # Options used in model training. # The hyperprameters selected for this trial.
"activationFn": "A String", # Activation function of the neural nets.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"approxGlobalFeatureContrib": True or False, # Whether to use approximate feature contribution method in XGBoost model explanation for global explain.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of the sum of non-seasonal p and q.
"autoArimaMinOrder": "A String", # The min value of the sum of non-seasonal p and q.
"autoClassWeights": True or False, # Whether to calculate class weights automatically based on the popularity of each label.
"batchSize": "A String", # Batch size for dnn models.
"boosterType": "A String", # Booster type for boosted tree models.
"budgetHours": 3.14, # Budget in hours for AutoML training.
"calculatePValues": True or False, # Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.
"categoryEncodingMethod": "A String", # Categorical feature encoding method.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"colorSpace": "A String", # Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.
"colsampleBylevel": 3.14, # Subsample ratio of columns for each level for boosted tree models.
"colsampleBynode": 3.14, # Subsample ratio of columns for each node(split) for boosted tree models.
"colsampleBytree": 3.14, # Subsample ratio of columns when constructing each tree for boosted tree models.
"dartNormalizeType": "A String", # Type of normalization algorithm for boosted tree models using dart booster.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"enableGlobalExplain": True or False, # If true, enable global explanation during training.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"fitIntercept": True or False, # Whether the model should include intercept during model training.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"holidayRegions": [ # A list of geographical regions that are used for time series modeling.
"A String",
],
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for.
"A String",
],
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"instanceWeightColumn": "A String", # Name of the instance weight column for training data. This column isn't be used as a feature.
"integratedGradientsNumSteps": "A String", # Number of integral steps for the integrated gradients explain method.
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1RegActivation": 3.14, # L1 regularization coefficient to activations.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxParallelTrials": "A String", # Maximum number of trials to run in parallel.
"maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.
"minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models.
"modelRegistry": "A String", # The model registry.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"numParallelTree": "A String", # Number of parallel trees constructed during each iteration for boosted tree models.
"numPrincipalComponents": "A String", # Number of principal components to keep in the PCA model. Must be <= the number of features.
"numTrials": "A String", # Number of trials to run this hyperparameter tuning job.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"optimizer": "A String", # Optimizer used for training the neural nets.
"pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model.
"pcaSolver": "A String", # The solver for PCA.
"sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method.
"scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.
"standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"tfVersion": "A String", # Based on the selected TF version, the corresponding docker image is used to train external models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesLengthFraction": 3.14, # The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"treeMethod": "A String", # Tree construction algorithm for boosted tree models.
"trendSmoothingWindowSize": "A String", # Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.
"userColumn": "A String", # User column specified for matrix factorization models.
"vertexAiModelVersionAliases": [ # The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.
"A String",
],
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
"xgboostVersion": "A String", # User-selected XGBoost versions for training of XGBoost models.
},
"startTimeMs": "A String", # Starting time of the trial.
"status": "A String", # The status of the trial.
"trainingLoss": 3.14, # Loss computed on the training data at the end of trial.
"trialId": "A String", # 1-based index of the trial.
},
],
"iterationResults": [ # Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. # Arima result.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"principalComponentInfos": [ # The information of the principal components.
{ # Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.
"cumulativeExplainedVarianceRatio": 3.14, # The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.
"explainedVariance": 3.14, # Explained variance by this principal component, which is simply the eigenvalue.
"explainedVarianceRatio": 3.14, # Explained_variance over the total explained variance.
"principalComponentId": "A String", # Id of the principal component.
},
],
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"maxIterations": "A String", # 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": "A String", # Output only. The type of the model that is being trained.
"trainingType": "A String", # Output only. Training type of the job.
},
"modelTraining": { # Deprecated.
"currentIteration": 42, # Deprecated.
"expectedTotalIterations": "A String", # Deprecated.
},
"modelTrainingCurrentIteration": 42, # Deprecated.
"modelTrainingExpectedTotalIteration": "A String", # Deprecated.
"numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"performanceInsights": { # Performance insights for the job. # Output only. Performance insights.
"avgPreviousExecutionMs": "A String", # 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": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.
{ # Performance insights compared to the previous executions for a specific stage.
"inputDataChange": { # Details about the input data change insight. # Output only. Input data change insight of the query stage.
"recordsReadDiffPercentage": 3.14, # Output only. Records read difference percentage compared to a previous run.
},
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
"stagePerformanceStandaloneInsights": [ # Output only. Standalone query stage performance insights, for exploring potential improvements.
{ # Standalone performance insights for a specific stage.
"biEngineReasons": [ # Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
"highCardinalityJoins": [ # Output only. High cardinality joins in the stage.
{ # High cardinality join detailed information.
"leftRows": "A String", # Output only. Count of left input rows.
"outputRows": "A String", # Output only. Count of the output rows.
"rightRows": "A String", # Output only. Count of right input rows.
"stepIndex": 42, # Output only. The index of the join operator in the ExplainQueryStep lists.
},
],
"insufficientShuffleQuota": True or False, # Output only. True if the stage has insufficient shuffle quota.
"partitionSkew": { # Partition skew detailed information. # Output only. Partition skew in the stage.
"skewSources": [ # Output only. Source stages which produce skewed data.
{ # Details about source stages which produce skewed data.
"stageId": "A String", # Output only. Stage id of the skew source stage.
},
],
},
"slotContention": True or False, # Output only. True if the stage has a slot contention issue.
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
},
"queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job.
"optimizationDetails": { # Output only. Information about query optimizations.
"a_key": "", # Properties of the object.
},
},
"queryPlan": [ # Output only. Describes execution plan for the query.
{ # A single stage of query execution.
"completedParallelInputs": "A String", # Number of parallel input segments completed.
"computeMode": "A String", # Output only. Compute mode for this stage.
"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.
"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.
"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
"endMs": "A String", # Stage end time represented as milliseconds since the epoch.
"id": "A String", # Unique ID for the stage within the plan.
"inputStages": [ # IDs for stages that are inputs to this stage.
"A String",
],
"name": "A String", # Human-readable name for the stage.
"parallelInputs": "A String", # Number of parallel input segments to be processed
"readMsAvg": "A String", # Milliseconds the average shard spent reading input.
"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.
"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
"recordsRead": "A String", # Number of records read into the stage.
"recordsWritten": "A String", # Number of records written by the stage.
"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.
"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.
"slotMs": "A String", # Slot-milliseconds used by the stage.
"startMs": "A String", # Stage start time represented as milliseconds since the epoch.
"status": "A String", # Current status for this stage.
"steps": [ # List of operations within the stage in dependency order (approximately chronological).
{ # An operation within a stage.
"kind": "A String", # Machine-readable operation type.
"substeps": [ # Human-readable description of the step(s).
"A String",
],
},
],
"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.
"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.
"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.
"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.
"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
},
],
"referencedRoutines": [ # Output only. Referenced routines for the job.
{ # Id path of a routine.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
],
"referencedTables": [ # Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"schema": { # Schema of a table # Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
"sparkStatistics": { # Statistics for a BigSpark query. Populated as part of JobStatistics2 # Output only. Statistics of a Spark procedure job.
"endpoints": { # Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.
"a_key": "A String",
},
"gcsStagingBucket": "A 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": "A 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": { # Spark job logs can be filtered by these fields in Cloud Logging. # Output only. Logging info is used to generate a link to Cloud Logging.
"projectId": "A String", # Output only. Project ID where the Spark logs were written.
"resourceType": "A String", # Output only. Resource type used for logging.
},
"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully.
"sparkJobLocation": "A 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": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement.
"timeline": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
"totalBytesBilled": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A 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": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
},
"quotaDeferments": [ # Output only. Quotas which delayed this job's start time.
"A String",
],
"reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"reservation_id": "A 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": { # Statistics for row-level security. # Output only. Statistics for row-level security. Present only for query and extract jobs.
"rowLevelSecurityApplied": True or False, # Whether any accessed data was protected by row access policies.
},
"scriptStatistics": { # Job statistics specific to the child job of a script. # Output only. If this a child job of a script, specifies information about the context of this job within the script.
"evaluationKind": "A String", # Whether this child job was a statement or expression.
"stackFrames": [ # 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.
{ # Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a ";", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab "snaps" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.
"endColumn": 42, # Output only. One-based end column.
"endLine": 42, # Output only. One-based end line.
"procedureId": "A String", # Output only. Name of the active procedure, empty if in a top-level script.
"startColumn": 42, # Output only. One-based start column.
"startLine": 42, # Output only. One-based start line.
"text": "A String", # Output only. Text of the current statement/expression.
},
],
},
"sessionInfo": { # [Preview] Information related to sessions. # Output only. Information of the session if this job is part of one.
"sessionId": "A String", # Output only. The id of the session.
},
"startTime": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transactionInfo": { # [Alpha] Information of a multi-statement transaction. # Output only. [Alpha] Information of the multi-statement transaction if this job is part of one. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
"transactionId": "A String", # Output only. [Alpha] Id of the transaction.
},
},
"status": { # Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
"errorResult": { # Error details. # Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
"errors": [ # 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.
{ # Error details.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
],
"state": "A String", # Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.
},
"user_email": "A String", # Output only. Email address of the user who ran the job.
},
"kind": "bigquery#jobCancelResponse", # The resource type of the response.
}

close()

Close httplib2 connections.

delete(projectId, jobId, location=None, x__xgafv=None)

Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted.

Args:
  projectId: string, Required. Project ID of the job for which metadata is to be deleted. (required)
  jobId: string, Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed. (required)
  location: string, The geographic location of the job. Required. See details at: https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

get(projectId, jobId, location=None, x__xgafv=None)

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.

Args:
projectId: string, Required. Project ID of the requested job. (required)
jobId: string, Required. Job ID of the requested job. (required)
location: string, The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"configuration": { # Required. Describes the job configuration.
"copy": { # 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). # [Pick one] Copies a table.
"createDisposition": "A 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": { # Custom encryption configuration (e.g., Cloud KMS keys).
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationExpirationTime": "A String", # Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
"destinationTable": { # [Required] The destination table.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Optional. Supported operation types in table copy job.
"sourceTable": { # [Pick one] Source table to copy.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # [Pick one] Source tables to copy.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A 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": True or False, # 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 configures a job that exports data from a BigQuery table into Google Cloud Storage. # [Pick one] Configures an extract job.
"compression": "A 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": "A 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": "A 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": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
"A String",
],
"fieldDelimiter": "A 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": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models.
"trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.
},
"printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
"sourceModel": { # Id path of a model. # A reference to the model being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this model.
"modelId": "A 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": "A String", # Required. The ID of the project containing this model.
},
"sourceTable": { # A reference to the table being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.
},
"jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.
"jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
"labels": { # 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.
"a_key": "A String",
},
"load": { # JobConfigurationLoad contains the configuration properties for loading data into a destination table. # [Pick one] Configures a load job.
"allowJaggedRows": True or False, # 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": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"autodetect": True or False, # Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"clustering": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # 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.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to only copy files to the destination BigLake managed table with an external storage_uri, without reading file content and writing them to new files. Copying files only is supported when: * source_uris are in the same external storage system as the destination table but they do not overlap with storage_uri of the destination table. * source_format is the same file format as the destination table. * destination_table is an existing BigLake managed table. Its schema does not have default value expression. It schema does not have type parameters other than precision and scale. * No options other than the above are specified.
"createDisposition": "A 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": True or False, # 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.
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # [Required] The destination table to load the data into.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Properties for the destination table. # Optional. [Experimental] Properties with which to create the destination table if it is new.
"description": "A 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": "A String", # Internal use only.
"friendlyName": "A String", # Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.
"labels": { # 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.
"a_key": "A String",
},
},
"encoding": "A 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": "A 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": "A String", # 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": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.
"jsonExtension": "A String", # 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": 42, # 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": "A 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.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"preserveAsciiControlCharacters": True or False, # 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": [ # 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.
"A String",
],
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"referenceFileSchemaUri": "A 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": { # Schema of a table # Optional. The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaUpdateOptions": [ # 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 two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"skipLeadingRows": 42, # 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.
"sourceFormat": "A 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": [ # [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.
"A String",
],
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useAvroLogicalTypes": True or False, # 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": "A 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_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.
},
"query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job.
"allowLargeResults": false, # 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": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # Connection properties which can modify the query behavior.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"continuous": True or False, # [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
"createDisposition": "A 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": True or False, # 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": { # Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable `@@dataset_id` achieves the same behavior. See https://cloud.google.com/bigquery/docs/reference/system-variables for more information on system variables.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": true, # 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": 1, # 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": "A String", # 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": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
"priority": "A String", # Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.
"queryParameters": [ # Query parameters for GoogleSQL queries.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts.
"keyResultStatement": "A String", # 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": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error.
"statementTimeoutMs": "A String", # Timeout period for each statement in a script.
},
"systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables.
"types": { # Output only. Data type for each system variable.
"a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } }
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE".
"structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [ # Fields within the struct.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
},
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
"values": { # Output only. Value for each system variable.
"a_key": "", # Properties of the object.
},
},
"tableDefinitions": { # 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.
"a_key": {
"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"avroOptions": { # Options for external data sources. # Optional. Additional properties to set if sourceFormat is set to AVRO.
"useAvroLogicalTypes": True or False, # 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).
},
"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE.
"columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
{ # Information related to a Bigtable column family.
"columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
{ # Information related to a Bigtable column.
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
"fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.
"onlyReadLatest": True or False, # Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.
"qualifierString": "A String", # Qualifier string.
"type": "A String", # Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
},
],
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
"familyId": "A String", # Identifier of the column family.
"onlyReadLatest": True or False, # Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
"type": "A String", # Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
},
],
"ignoreUnspecifiedColumnFamilies": True or False, # Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
"outputColumnFamiliesAsJson": True or False, # Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
"readRowkeyAsString": True or False, # Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
},
"compression": "A String", # Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.
"connectionId": "A String", # Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form "<project\_id>.<location\_id>.<connection\_id>" or "projects/<project\_id>/locations/<location\_id>/connections/<connection\_id>".
"csvOptions": { # Information related to a CSV data source. # Optional. Additional properties to set if sourceFormat is set to CSV.
"allowJaggedRows": True or False, # Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
"allowQuotedNewlines": True or False, # Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"encoding": "A 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.
"fieldDelimiter": "A 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).
"nullMarker": "A String", # [Optional] A custom string that will represent a NULL value in CSV import data.
"preserveAsciiControlCharacters": True or False, # Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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 ' "" '.
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
"googleSheetsOptions": { # Options specific to Google Sheets data sources. # Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
"range": "A String", # Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, 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.
},
"hivePartitioningOptions": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.
"jsonExtension": "A String", # 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).
"jsonOptions": { # Json Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to JSON.
"encoding": "A String", # Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
},
"maxBadRecords": 42, # Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.
"metadataCacheMode": "A String", # Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
"objectMetadata": "A String", # Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
"schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
"A String",
],
},
},
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useLegacySql": true, # Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
"useQueryCache": true, # 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": [ # Describes user-defined function resources used in the query.
{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
},
],
"writeDisposition": "A 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_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.
},
},
"etag": "A String", # Output only. A hash of this resource.
"id": "A String", # Output only. Opaque ID field of the job.
"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`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
"code": "A String", # Output only. Specifies the high level reason why a Job was created.
},
"jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job.
"jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
},
"kind": "bigquery#job", # Output only. The type of the resource.
"principal_subject": "A 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": "A String", # Output only. A URL that can be used to access the resource again.
"statistics": { # Statistics for a single job execution. # Output only. Information about the job, including starting time and ending time of the job.
"completionRatio": 3.14, # Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job.
"copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table.
"copiedRows": "A String", # Output only. Number of rows copied to the destination table.
},
"creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
"endTime": "A String", # 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": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # 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.
"A String",
],
"inputBytes": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"finalExecutionDurationMs": "A String", # 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.
"load": { # Statistics for a load job. # Output only. Statistics for a load job.
"badRecords": "A String", # 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": "A String", # Output only. Number of bytes of source data in a load job.
"inputFiles": "A String", # Output only. Number of source files in a load job.
"outputBytes": "A String", # 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": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"numChildJobs": "A String", # Output only. Number of child jobs executed.
"parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent.
"query": { # Statistics for a query job. # Output only. Statistics for a query job.
"biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics.
"accelerationMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineReasons": [ # 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.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
},
"billingTier": 42, # 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": True or False, # Output only. Whether the query result was fetched from the query cache.
"dclTargetDataset": { # Output only. Referenced dataset for DCL statement.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"dclTargetTable": { # Output only. Referenced table for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Output only. Referenced view for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
"ddlDestinationTable": { # Output only. The table after rename. Present only for ALTER TABLE RENAME TO query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
"ddlTargetDataset": { # Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"ddlTargetRoutine": { # Id path of a routine. # Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
"ddlTargetRowAccessPolicy": { # Id path of a row access policy. # Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
"datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
"policyId": "A 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": "A String", # Required. The ID of the project containing this row access policy.
"tableId": "A String", # Required. The ID of the table containing this row access policy.
},
"ddlTargetTable": { # Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
"deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
"insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
"updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.
},
"estimatedBytesProcessed": "A String", # Output only. The original estimate of bytes processed for the job.
"exportDataStatistics": { # Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. # Output only. Stats for EXPORT DATA statement.
"fileCount": "A String", # Number of destination files generated in case of EXPORT DATA statement only.
"rowCount": "A String", # [Alpha] Number of destination rows generated in case of EXPORT DATA statement only.
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
"reservedSlotCount": "A String", # 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": "A String", # External service cost in terms of bigquery slot milliseconds.
},
],
"loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query.
"badRecords": "A String", # 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": "A String", # 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": "A String", # Output only. Number of bytes of source data in a LOAD query.
"inputFiles": "A String", # Output only. Number of source files in a LOAD query.
"outputBytes": "A String", # 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": "A String", # 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": { # Statistics of materialized views considered in a query job. # Output only. Statistics of materialized views of a query job.
"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.
{ # A materialized view considered for a query job.
"chosen": True or False, # 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": "A String", # If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.
"rejectedReason": "A String", # If present, specifies the reason why the materialized view was not chosen for the query.
"tableReference": { # The candidate materialized view.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
},
],
},
"metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables.
"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query.
{ # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.
"explanation": "A String", # Free form human-readable reason metadata caching was unused for the job.
"tableReference": { # Metadata caching eligible table referenced in the query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"tableType": "A String", # [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).
"unusedReason": "A String", # Reason for not using metadata caching for the table.
},
],
},
"mlStatistics": { # Job statistics specific to a BigQuery ML training job. # Output only. Statistics of a BigQuery ML training job.
"hparamTrials": [ # Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
{ # Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.
"endTimeMs": "A String", # Ending time of the trial.
"errorMessage": "A String", # Error message for FAILED and INFEASIBLE trial.
"evalLoss": 3.14, # Loss computed on the eval data at the end of trial.
"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. # Evaluation metrics of this trial calculated on the test data. Empty in Job API.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparamTuningEvaluationMetrics": { # 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. # Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparams": { # Options used in model training. # The hyperprameters selected for this trial.
"activationFn": "A String", # Activation function of the neural nets.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"approxGlobalFeatureContrib": True or False, # Whether to use approximate feature contribution method in XGBoost model explanation for global explain.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of the sum of non-seasonal p and q.
"autoArimaMinOrder": "A String", # The min value of the sum of non-seasonal p and q.
"autoClassWeights": True or False, # Whether to calculate class weights automatically based on the popularity of each label.
"batchSize": "A String", # Batch size for dnn models.
"boosterType": "A String", # Booster type for boosted tree models.
"budgetHours": 3.14, # Budget in hours for AutoML training.
"calculatePValues": True or False, # Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.
"categoryEncodingMethod": "A String", # Categorical feature encoding method.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"colorSpace": "A String", # Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.
"colsampleBylevel": 3.14, # Subsample ratio of columns for each level for boosted tree models.
"colsampleBynode": 3.14, # Subsample ratio of columns for each node(split) for boosted tree models.
"colsampleBytree": 3.14, # Subsample ratio of columns when constructing each tree for boosted tree models.
"dartNormalizeType": "A String", # Type of normalization algorithm for boosted tree models using dart booster.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"enableGlobalExplain": True or False, # If true, enable global explanation during training.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"fitIntercept": True or False, # Whether the model should include intercept during model training.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"holidayRegions": [ # A list of geographical regions that are used for time series modeling.
"A String",
],
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for.
"A String",
],
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"instanceWeightColumn": "A String", # Name of the instance weight column for training data. This column isn't be used as a feature.
"integratedGradientsNumSteps": "A String", # Number of integral steps for the integrated gradients explain method.
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1RegActivation": 3.14, # L1 regularization coefficient to activations.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxParallelTrials": "A String", # Maximum number of trials to run in parallel.
"maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.
"minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models.
"modelRegistry": "A String", # The model registry.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"numParallelTree": "A String", # Number of parallel trees constructed during each iteration for boosted tree models.
"numPrincipalComponents": "A String", # Number of principal components to keep in the PCA model. Must be <= the number of features.
"numTrials": "A String", # Number of trials to run this hyperparameter tuning job.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"optimizer": "A String", # Optimizer used for training the neural nets.
"pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model.
"pcaSolver": "A String", # The solver for PCA.
"sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method.
"scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.
"standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"tfVersion": "A String", # Based on the selected TF version, the corresponding docker image is used to train external models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesLengthFraction": 3.14, # The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"treeMethod": "A String", # Tree construction algorithm for boosted tree models.
"trendSmoothingWindowSize": "A String", # Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.
"userColumn": "A String", # User column specified for matrix factorization models.
"vertexAiModelVersionAliases": [ # The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.
"A String",
],
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
"xgboostVersion": "A String", # User-selected XGBoost versions for training of XGBoost models.
},
"startTimeMs": "A String", # Starting time of the trial.
"status": "A String", # The status of the trial.
"trainingLoss": 3.14, # Loss computed on the training data at the end of trial.
"trialId": "A String", # 1-based index of the trial.
},
],
"iterationResults": [ # Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. # Arima result.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"principalComponentInfos": [ # The information of the principal components.
{ # Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.
"cumulativeExplainedVarianceRatio": 3.14, # The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.
"explainedVariance": 3.14, # Explained variance by this principal component, which is simply the eigenvalue.
"explainedVarianceRatio": 3.14, # Explained_variance over the total explained variance.
"principalComponentId": "A String", # Id of the principal component.
},
],
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"maxIterations": "A String", # 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": "A String", # Output only. The type of the model that is being trained.
"trainingType": "A String", # Output only. Training type of the job.
},
"modelTraining": { # Deprecated.
"currentIteration": 42, # Deprecated.
"expectedTotalIterations": "A String", # Deprecated.
},
"modelTrainingCurrentIteration": 42, # Deprecated.
"modelTrainingExpectedTotalIteration": "A String", # Deprecated.
"numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"performanceInsights": { # Performance insights for the job. # Output only. Performance insights.
"avgPreviousExecutionMs": "A String", # 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": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.
{ # Performance insights compared to the previous executions for a specific stage.
"inputDataChange": { # Details about the input data change insight. # Output only. Input data change insight of the query stage.
"recordsReadDiffPercentage": 3.14, # Output only. Records read difference percentage compared to a previous run.
},
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
"stagePerformanceStandaloneInsights": [ # Output only. Standalone query stage performance insights, for exploring potential improvements.
{ # Standalone performance insights for a specific stage.
"biEngineReasons": [ # Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
"highCardinalityJoins": [ # Output only. High cardinality joins in the stage.
{ # High cardinality join detailed information.
"leftRows": "A String", # Output only. Count of left input rows.
"outputRows": "A String", # Output only. Count of the output rows.
"rightRows": "A String", # Output only. Count of right input rows.
"stepIndex": 42, # Output only. The index of the join operator in the ExplainQueryStep lists.
},
],
"insufficientShuffleQuota": True or False, # Output only. True if the stage has insufficient shuffle quota.
"partitionSkew": { # Partition skew detailed information. # Output only. Partition skew in the stage.
"skewSources": [ # Output only. Source stages which produce skewed data.
{ # Details about source stages which produce skewed data.
"stageId": "A String", # Output only. Stage id of the skew source stage.
},
],
},
"slotContention": True or False, # Output only. True if the stage has a slot contention issue.
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
},
"queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job.
"optimizationDetails": { # Output only. Information about query optimizations.
"a_key": "", # Properties of the object.
},
},
"queryPlan": [ # Output only. Describes execution plan for the query.
{ # A single stage of query execution.
"completedParallelInputs": "A String", # Number of parallel input segments completed.
"computeMode": "A String", # Output only. Compute mode for this stage.
"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.
"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.
"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
"endMs": "A String", # Stage end time represented as milliseconds since the epoch.
"id": "A String", # Unique ID for the stage within the plan.
"inputStages": [ # IDs for stages that are inputs to this stage.
"A String",
],
"name": "A String", # Human-readable name for the stage.
"parallelInputs": "A String", # Number of parallel input segments to be processed
"readMsAvg": "A String", # Milliseconds the average shard spent reading input.
"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.
"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
"recordsRead": "A String", # Number of records read into the stage.
"recordsWritten": "A String", # Number of records written by the stage.
"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.
"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.
"slotMs": "A String", # Slot-milliseconds used by the stage.
"startMs": "A String", # Stage start time represented as milliseconds since the epoch.
"status": "A String", # Current status for this stage.
"steps": [ # List of operations within the stage in dependency order (approximately chronological).
{ # An operation within a stage.
"kind": "A String", # Machine-readable operation type.
"substeps": [ # Human-readable description of the step(s).
"A String",
],
},
],
"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.
"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.
"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.
"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.
"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
},
],
"referencedRoutines": [ # Output only. Referenced routines for the job.
{ # Id path of a routine.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
],
"referencedTables": [ # Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"schema": { # Schema of a table # Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
"sparkStatistics": { # Statistics for a BigSpark query. Populated as part of JobStatistics2 # Output only. Statistics of a Spark procedure job.
"endpoints": { # Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.
"a_key": "A String",
},
"gcsStagingBucket": "A 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": "A 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": { # Spark job logs can be filtered by these fields in Cloud Logging. # Output only. Logging info is used to generate a link to Cloud Logging.
"projectId": "A String", # Output only. Project ID where the Spark logs were written.
"resourceType": "A String", # Output only. Resource type used for logging.
},
"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully.
"sparkJobLocation": "A 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": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement.
"timeline": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
"totalBytesBilled": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A 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": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
},
"quotaDeferments": [ # Output only. Quotas which delayed this job's start time.
"A String",
],
"reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"reservation_id": "A 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": { # Statistics for row-level security. # Output only. Statistics for row-level security. Present only for query and extract jobs.
"rowLevelSecurityApplied": True or False, # Whether any accessed data was protected by row access policies.
},
"scriptStatistics": { # Job statistics specific to the child job of a script. # Output only. If this a child job of a script, specifies information about the context of this job within the script.
"evaluationKind": "A String", # Whether this child job was a statement or expression.
"stackFrames": [ # 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.
{ # Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a ";", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab "snaps" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.
"endColumn": 42, # Output only. One-based end column.
"endLine": 42, # Output only. One-based end line.
"procedureId": "A String", # Output only. Name of the active procedure, empty if in a top-level script.
"startColumn": 42, # Output only. One-based start column.
"startLine": 42, # Output only. One-based start line.
"text": "A String", # Output only. Text of the current statement/expression.
},
],
},
"sessionInfo": { # [Preview] Information related to sessions. # Output only. Information of the session if this job is part of one.
"sessionId": "A String", # Output only. The id of the session.
},
"startTime": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transactionInfo": { # [Alpha] Information of a multi-statement transaction. # Output only. [Alpha] Information of the multi-statement transaction if this job is part of one. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
"transactionId": "A String", # Output only. [Alpha] Id of the transaction.
},
},
"status": { # Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
"errorResult": { # Error details. # Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
"errors": [ # 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.
{ # Error details.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
],
"state": "A String", # Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.
},
"user_email": "A String", # Output only. Email address of the user who ran the job.
}

getQueryResults(projectId, jobId, formatOptions_useInt64Timestamp=None, location=None, maxResults=None, pageToken=None, startIndex=None, timeoutMs=None, x__xgafv=None)

RPC to get the results of a query job.

Args:
  projectId: string, Required. Project ID of the query job. (required)
  jobId: string, Required. Job ID of the query job. (required)
  formatOptions_useInt64Timestamp: boolean, Optional. Output timestamp as usec int64. Default is false.
  location: string, The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
  maxResults: integer, Maximum number of results to read.
  pageToken: string, Page token, returned by a previous call, to request the next page of results.
  startIndex: string, Zero-based index of the starting row.
  timeoutMs: integer, Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response object of GetQueryResults.
  "cacheHit": True or False, # Whether the query result was fetched from the query cache.
  "errors": [ # Output only. The first errors or warnings 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 completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).
    { # Error details.
      "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
      "location": "A String", # Specifies where the error occurred, if present.
      "message": "A String", # A human-readable description of the error.
      "reason": "A String", # A short error code that summarizes the error.
    },
  ],
  "etag": "A String", # A hash of this response.
  "jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
  "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
    "jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
  },
  "kind": "bigquery#getQueryResultsResponse", # The resource type of the response.
  "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
  "pageToken": "A String", # A token used for paging results. When this token is non-empty, it indicates additional results are available.
  "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. The REST-based representation of this data leverages a series of JSON f,v objects for indicating fields and values.
    {
      "f": [ # Represents a single row in the result set, consisting of one or more fields.
        {
          "v": "",
        },
      ],
    },
  ],
  "schema": { # Schema of a table # The schema of the results. Present only when the query completes successfully.
    "fields": [ # Describes the fields in a table.
      { # A field in TableSchema
        "categories": { # Deprecated.
          "names": [ # Deprecated.
            "A String",
          ],
        },
        "collation": "A 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.
        "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
        "description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
        "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
          # Object with schema name: TableFieldSchema
        ],
        "maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
        "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
        "policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
          "names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
            "A String",
          ],
        },
        "precision": "A String", # 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": { # Represents the type of a field element.
          "type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
        },
        "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
        "scale": "A String", # Optional. See documentation for precision.
        "type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
      },
    ],
  },
  "totalBytesProcessed": "A String", # The total number of bytes processed for this query.
  "totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
}

getQueryResults_next()

Retrieves the next page of results.

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

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

insert(projectId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts.

Args:
projectId: string, Project ID of project that will be billed for the job. (required)
body: object, The request body.
The object takes the form of:

{
"configuration": { # Required. Describes the job configuration.
"copy": { # 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). # [Pick one] Copies a table.
"createDisposition": "A 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": { # Custom encryption configuration (e.g., Cloud KMS keys).
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationExpirationTime": "A String", # Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
"destinationTable": { # [Required] The destination table.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Optional. Supported operation types in table copy job.
"sourceTable": { # [Pick one] Source table to copy.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # [Pick one] Source tables to copy.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A 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": True or False, # 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 configures a job that exports data from a BigQuery table into Google Cloud Storage. # [Pick one] Configures an extract job.
"compression": "A 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": "A 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": "A 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": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
"A String",
],
"fieldDelimiter": "A 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": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models.
"trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.
},
"printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
"sourceModel": { # Id path of a model. # A reference to the model being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this model.
"modelId": "A 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": "A String", # Required. The ID of the project containing this model.
},
"sourceTable": { # A reference to the table being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.
},
"jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.
"jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
"labels": { # 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.
"a_key": "A String",
},
"load": { # JobConfigurationLoad contains the configuration properties for loading data into a destination table. # [Pick one] Configures a load job.
"allowJaggedRows": True or False, # 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": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"autodetect": True or False, # Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"clustering": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # 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.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to only copy files to the destination BigLake managed table with an external storage_uri, without reading file content and writing them to new files. Copying files only is supported when: * source_uris are in the same external storage system as the destination table but they do not overlap with storage_uri of the destination table. * source_format is the same file format as the destination table. * destination_table is an existing BigLake managed table. Its schema does not have default value expression. It schema does not have type parameters other than precision and scale. * No options other than the above are specified.
"createDisposition": "A 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": True or False, # 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.
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # [Required] The destination table to load the data into.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Properties for the destination table. # Optional. [Experimental] Properties with which to create the destination table if it is new.
"description": "A 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": "A String", # Internal use only.
"friendlyName": "A String", # Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.
"labels": { # 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.
"a_key": "A String",
},
},
"encoding": "A 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": "A 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": "A String", # 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": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.
"jsonExtension": "A String", # 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": 42, # 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": "A 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.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"preserveAsciiControlCharacters": True or False, # 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": [ # 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.
"A String",
],
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"referenceFileSchemaUri": "A 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": { # Schema of a table # Optional. The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaUpdateOptions": [ # 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 two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"skipLeadingRows": 42, # 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.
"sourceFormat": "A 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": [ # [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.
"A String",
],
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useAvroLogicalTypes": True or False, # 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": "A 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_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.
},
"query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job.
"allowLargeResults": false, # 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": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # Connection properties which can modify the query behavior.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"continuous": True or False, # [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
"createDisposition": "A 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": True or False, # 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": { # Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable `@@dataset_id` achieves the same behavior. See https://cloud.google.com/bigquery/docs/reference/system-variables for more information on system variables.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": true, # 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": 1, # 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": "A String", # 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": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
"priority": "A String", # Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.
"queryParameters": [ # Query parameters for GoogleSQL queries.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts.
"keyResultStatement": "A String", # 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": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error.
"statementTimeoutMs": "A String", # Timeout period for each statement in a script.
},
"systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables.
"types": { # Output only. Data type for each system variable.
"a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } }
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE".
"structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [ # Fields within the struct.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
},
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
"values": { # Output only. Value for each system variable.
"a_key": "", # Properties of the object.
},
},
"tableDefinitions": { # 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.
"a_key": {
"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"avroOptions": { # Options for external data sources. # Optional. Additional properties to set if sourceFormat is set to AVRO.
"useAvroLogicalTypes": True or False, # 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).
},
"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE.
"columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
{ # Information related to a Bigtable column family.
"columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
{ # Information related to a Bigtable column.
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
"fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.
"onlyReadLatest": True or False, # Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.
"qualifierString": "A String", # Qualifier string.
"type": "A String", # Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
},
],
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
"familyId": "A String", # Identifier of the column family.
"onlyReadLatest": True or False, # Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
"type": "A String", # Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
},
],
"ignoreUnspecifiedColumnFamilies": True or False, # Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
"outputColumnFamiliesAsJson": True or False, # Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
"readRowkeyAsString": True or False, # Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
},
"compression": "A String", # Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.
"connectionId": "A String", # Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form "<project\_id>.<location\_id>.<connection\_id>" or "projects/<project\_id>/locations/<location\_id>/connections/<connection\_id>".
"csvOptions": { # Information related to a CSV data source. # Optional. Additional properties to set if sourceFormat is set to CSV.
"allowJaggedRows": True or False, # Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
"allowQuotedNewlines": True or False, # Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"encoding": "A 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.
"fieldDelimiter": "A 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).
"nullMarker": "A String", # [Optional] A custom string that will represent a NULL value in CSV import data.
"preserveAsciiControlCharacters": True or False, # Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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 ' "" '.
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
"googleSheetsOptions": { # Options specific to Google Sheets data sources. # Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
"range": "A String", # Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, 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.
},
"hivePartitioningOptions": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.
"jsonExtension": "A String", # 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).
"jsonOptions": { # Json Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to JSON.
"encoding": "A String", # Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
},
"maxBadRecords": 42, # Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.
"metadataCacheMode": "A String", # Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
"objectMetadata": "A String", # Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
"schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
"A String",
],
},
},
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useLegacySql": true, # Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
"useQueryCache": true, # 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": [ # Describes user-defined function resources used in the query.
{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
},
],
"writeDisposition": "A 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_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.
},
},
"etag": "A String", # Output only. A hash of this resource.
"id": "A String", # Output only. Opaque ID field of the job.
"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`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
"code": "A String", # Output only. Specifies the high level reason why a Job was created.
},
"jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job.
"jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
},
"kind": "bigquery#job", # Output only. The type of the resource.
"principal_subject": "A 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": "A String", # Output only. A URL that can be used to access the resource again.
"statistics": { # Statistics for a single job execution. # Output only. Information about the job, including starting time and ending time of the job.
"completionRatio": 3.14, # Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job.
"copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table.
"copiedRows": "A String", # Output only. Number of rows copied to the destination table.
},
"creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
"endTime": "A String", # 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": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # 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.
"A String",
],
"inputBytes": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"finalExecutionDurationMs": "A String", # 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.
"load": { # Statistics for a load job. # Output only. Statistics for a load job.
"badRecords": "A String", # 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": "A String", # Output only. Number of bytes of source data in a load job.
"inputFiles": "A String", # Output only. Number of source files in a load job.
"outputBytes": "A String", # 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": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"numChildJobs": "A String", # Output only. Number of child jobs executed.
"parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent.
"query": { # Statistics for a query job. # Output only. Statistics for a query job.
"biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics.
"accelerationMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineReasons": [ # 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.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
},
"billingTier": 42, # 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": True or False, # Output only. Whether the query result was fetched from the query cache.
"dclTargetDataset": { # Output only. Referenced dataset for DCL statement.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"dclTargetTable": { # Output only. Referenced table for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Output only. Referenced view for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
"ddlDestinationTable": { # Output only. The table after rename. Present only for ALTER TABLE RENAME TO query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
"ddlTargetDataset": { # Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"ddlTargetRoutine": { # Id path of a routine. # Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
"ddlTargetRowAccessPolicy": { # Id path of a row access policy. # Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
"datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
"policyId": "A 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": "A String", # Required. The ID of the project containing this row access policy.
"tableId": "A String", # Required. The ID of the table containing this row access policy.
},
"ddlTargetTable": { # Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
"deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
"insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
"updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.
},
"estimatedBytesProcessed": "A String", # Output only. The original estimate of bytes processed for the job.
"exportDataStatistics": { # Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. # Output only. Stats for EXPORT DATA statement.
"fileCount": "A String", # Number of destination files generated in case of EXPORT DATA statement only.
"rowCount": "A String", # [Alpha] Number of destination rows generated in case of EXPORT DATA statement only.
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
"reservedSlotCount": "A String", # 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": "A String", # External service cost in terms of bigquery slot milliseconds.
},
],
"loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query.
"badRecords": "A String", # 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": "A String", # 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": "A String", # Output only. Number of bytes of source data in a LOAD query.
"inputFiles": "A String", # Output only. Number of source files in a LOAD query.
"outputBytes": "A String", # 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": "A String", # 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": { # Statistics of materialized views considered in a query job. # Output only. Statistics of materialized views of a query job.
"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.
{ # A materialized view considered for a query job.
"chosen": True or False, # 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": "A String", # If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.
"rejectedReason": "A String", # If present, specifies the reason why the materialized view was not chosen for the query.
"tableReference": { # The candidate materialized view.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
},
],
},
"metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables.
"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query.
{ # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.
"explanation": "A String", # Free form human-readable reason metadata caching was unused for the job.
"tableReference": { # Metadata caching eligible table referenced in the query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"tableType": "A String", # [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).
"unusedReason": "A String", # Reason for not using metadata caching for the table.
},
],
},
"mlStatistics": { # Job statistics specific to a BigQuery ML training job. # Output only. Statistics of a BigQuery ML training job.
"hparamTrials": [ # Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
{ # Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.
"endTimeMs": "A String", # Ending time of the trial.
"errorMessage": "A String", # Error message for FAILED and INFEASIBLE trial.
"evalLoss": 3.14, # Loss computed on the eval data at the end of trial.
"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. # Evaluation metrics of this trial calculated on the test data. Empty in Job API.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparamTuningEvaluationMetrics": { # 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. # Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparams": { # Options used in model training. # The hyperprameters selected for this trial.
"activationFn": "A String", # Activation function of the neural nets.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"approxGlobalFeatureContrib": True or False, # Whether to use approximate feature contribution method in XGBoost model explanation for global explain.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of the sum of non-seasonal p and q.
"autoArimaMinOrder": "A String", # The min value of the sum of non-seasonal p and q.
"autoClassWeights": True or False, # Whether to calculate class weights automatically based on the popularity of each label.
"batchSize": "A String", # Batch size for dnn models.
"boosterType": "A String", # Booster type for boosted tree models.
"budgetHours": 3.14, # Budget in hours for AutoML training.
"calculatePValues": True or False, # Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.
"categoryEncodingMethod": "A String", # Categorical feature encoding method.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"colorSpace": "A String", # Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.
"colsampleBylevel": 3.14, # Subsample ratio of columns for each level for boosted tree models.
"colsampleBynode": 3.14, # Subsample ratio of columns for each node(split) for boosted tree models.
"colsampleBytree": 3.14, # Subsample ratio of columns when constructing each tree for boosted tree models.
"dartNormalizeType": "A String", # Type of normalization algorithm for boosted tree models using dart booster.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"enableGlobalExplain": True or False, # If true, enable global explanation during training.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"fitIntercept": True or False, # Whether the model should include intercept during model training.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"holidayRegions": [ # A list of geographical regions that are used for time series modeling.
"A String",
],
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for.
"A String",
],
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"instanceWeightColumn": "A String", # Name of the instance weight column for training data. This column isn't be used as a feature.
"integratedGradientsNumSteps": "A String", # Number of integral steps for the integrated gradients explain method.
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1RegActivation": 3.14, # L1 regularization coefficient to activations.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxParallelTrials": "A String", # Maximum number of trials to run in parallel.
"maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.
"minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models.
"modelRegistry": "A String", # The model registry.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"numParallelTree": "A String", # Number of parallel trees constructed during each iteration for boosted tree models.
"numPrincipalComponents": "A String", # Number of principal components to keep in the PCA model. Must be <= the number of features.
"numTrials": "A String", # Number of trials to run this hyperparameter tuning job.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"optimizer": "A String", # Optimizer used for training the neural nets.
"pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model.
"pcaSolver": "A String", # The solver for PCA.
"sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method.
"scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.
"standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"tfVersion": "A String", # Based on the selected TF version, the corresponding docker image is used to train external models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesLengthFraction": 3.14, # The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"treeMethod": "A String", # Tree construction algorithm for boosted tree models.
"trendSmoothingWindowSize": "A String", # Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.
"userColumn": "A String", # User column specified for matrix factorization models.
"vertexAiModelVersionAliases": [ # The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.
"A String",
],
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
"xgboostVersion": "A String", # User-selected XGBoost versions for training of XGBoost models.
},
"startTimeMs": "A String", # Starting time of the trial.
"status": "A String", # The status of the trial.
"trainingLoss": 3.14, # Loss computed on the training data at the end of trial.
"trialId": "A String", # 1-based index of the trial.
},
],
"iterationResults": [ # Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. # Arima result.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"principalComponentInfos": [ # The information of the principal components.
{ # Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.
"cumulativeExplainedVarianceRatio": 3.14, # The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.
"explainedVariance": 3.14, # Explained variance by this principal component, which is simply the eigenvalue.
"explainedVarianceRatio": 3.14, # Explained_variance over the total explained variance.
"principalComponentId": "A String", # Id of the principal component.
},
],
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"maxIterations": "A String", # 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": "A String", # Output only. The type of the model that is being trained.
"trainingType": "A String", # Output only. Training type of the job.
},
"modelTraining": { # Deprecated.
"currentIteration": 42, # Deprecated.
"expectedTotalIterations": "A String", # Deprecated.
},
"modelTrainingCurrentIteration": 42, # Deprecated.
"modelTrainingExpectedTotalIteration": "A String", # Deprecated.
"numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"performanceInsights": { # Performance insights for the job. # Output only. Performance insights.
"avgPreviousExecutionMs": "A String", # 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": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.
{ # Performance insights compared to the previous executions for a specific stage.
"inputDataChange": { # Details about the input data change insight. # Output only. Input data change insight of the query stage.
"recordsReadDiffPercentage": 3.14, # Output only. Records read difference percentage compared to a previous run.
},
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
"stagePerformanceStandaloneInsights": [ # Output only. Standalone query stage performance insights, for exploring potential improvements.
{ # Standalone performance insights for a specific stage.
"biEngineReasons": [ # Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
"highCardinalityJoins": [ # Output only. High cardinality joins in the stage.
{ # High cardinality join detailed information.
"leftRows": "A String", # Output only. Count of left input rows.
"outputRows": "A String", # Output only. Count of the output rows.
"rightRows": "A String", # Output only. Count of right input rows.
"stepIndex": 42, # Output only. The index of the join operator in the ExplainQueryStep lists.
},
],
"insufficientShuffleQuota": True or False, # Output only. True if the stage has insufficient shuffle quota.
"partitionSkew": { # Partition skew detailed information. # Output only. Partition skew in the stage.
"skewSources": [ # Output only. Source stages which produce skewed data.
{ # Details about source stages which produce skewed data.
"stageId": "A String", # Output only. Stage id of the skew source stage.
},
],
},
"slotContention": True or False, # Output only. True if the stage has a slot contention issue.
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
},
"queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job.
"optimizationDetails": { # Output only. Information about query optimizations.
"a_key": "", # Properties of the object.
},
},
"queryPlan": [ # Output only. Describes execution plan for the query.
{ # A single stage of query execution.
"completedParallelInputs": "A String", # Number of parallel input segments completed.
"computeMode": "A String", # Output only. Compute mode for this stage.
"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.
"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.
"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
"endMs": "A String", # Stage end time represented as milliseconds since the epoch.
"id": "A String", # Unique ID for the stage within the plan.
"inputStages": [ # IDs for stages that are inputs to this stage.
"A String",
],
"name": "A String", # Human-readable name for the stage.
"parallelInputs": "A String", # Number of parallel input segments to be processed
"readMsAvg": "A String", # Milliseconds the average shard spent reading input.
"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.
"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
"recordsRead": "A String", # Number of records read into the stage.
"recordsWritten": "A String", # Number of records written by the stage.
"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.
"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.
"slotMs": "A String", # Slot-milliseconds used by the stage.
"startMs": "A String", # Stage start time represented as milliseconds since the epoch.
"status": "A String", # Current status for this stage.
"steps": [ # List of operations within the stage in dependency order (approximately chronological).
{ # An operation within a stage.
"kind": "A String", # Machine-readable operation type.
"substeps": [ # Human-readable description of the step(s).
"A String",
],
},
],
"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.
"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.
"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.
"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.
"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
},
],
"referencedRoutines": [ # Output only. Referenced routines for the job.
{ # Id path of a routine.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
],
"referencedTables": [ # Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"schema": { # Schema of a table # Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
"sparkStatistics": { # Statistics for a BigSpark query. Populated as part of JobStatistics2 # Output only. Statistics of a Spark procedure job.
"endpoints": { # Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.
"a_key": "A String",
},
"gcsStagingBucket": "A 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": "A 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": { # Spark job logs can be filtered by these fields in Cloud Logging. # Output only. Logging info is used to generate a link to Cloud Logging.
"projectId": "A String", # Output only. Project ID where the Spark logs were written.
"resourceType": "A String", # Output only. Resource type used for logging.
},
"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully.
"sparkJobLocation": "A 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": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement.
"timeline": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
"totalBytesBilled": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A 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": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
},
"quotaDeferments": [ # Output only. Quotas which delayed this job's start time.
"A String",
],
"reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"reservation_id": "A 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": { # Statistics for row-level security. # Output only. Statistics for row-level security. Present only for query and extract jobs.
"rowLevelSecurityApplied": True or False, # Whether any accessed data was protected by row access policies.
},
"scriptStatistics": { # Job statistics specific to the child job of a script. # Output only. If this a child job of a script, specifies information about the context of this job within the script.
"evaluationKind": "A String", # Whether this child job was a statement or expression.
"stackFrames": [ # 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.
{ # Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a ";", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab "snaps" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.
"endColumn": 42, # Output only. One-based end column.
"endLine": 42, # Output only. One-based end line.
"procedureId": "A String", # Output only. Name of the active procedure, empty if in a top-level script.
"startColumn": 42, # Output only. One-based start column.
"startLine": 42, # Output only. One-based start line.
"text": "A String", # Output only. Text of the current statement/expression.
},
],
},
"sessionInfo": { # [Preview] Information related to sessions. # Output only. Information of the session if this job is part of one.
"sessionId": "A String", # Output only. The id of the session.
},
"startTime": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transactionInfo": { # [Alpha] Information of a multi-statement transaction. # Output only. [Alpha] Information of the multi-statement transaction if this job is part of one. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
"transactionId": "A String", # Output only. [Alpha] Id of the transaction.
},
},
"status": { # Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
"errorResult": { # Error details. # Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
"errors": [ # 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.
{ # Error details.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
],
"state": "A String", # Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.
},
"user_email": "A String", # Output only. Email address of the user who ran the job.
}

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"configuration": { # Required. Describes the job configuration.
"copy": { # 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). # [Pick one] Copies a table.
"createDisposition": "A 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": { # Custom encryption configuration (e.g., Cloud KMS keys).
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationExpirationTime": "A String", # Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
"destinationTable": { # [Required] The destination table.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Optional. Supported operation types in table copy job.
"sourceTable": { # [Pick one] Source table to copy.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # [Pick one] Source tables to copy.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A 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": True or False, # 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 configures a job that exports data from a BigQuery table into Google Cloud Storage. # [Pick one] Configures an extract job.
"compression": "A 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": "A 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": "A 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": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
"A String",
],
"fieldDelimiter": "A 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": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models.
"trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.
},
"printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
"sourceModel": { # Id path of a model. # A reference to the model being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this model.
"modelId": "A 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": "A String", # Required. The ID of the project containing this model.
},
"sourceTable": { # A reference to the table being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.
},
"jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.
"jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
"labels": { # 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.
"a_key": "A String",
},
"load": { # JobConfigurationLoad contains the configuration properties for loading data into a destination table. # [Pick one] Configures a load job.
"allowJaggedRows": True or False, # 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": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"autodetect": True or False, # Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"clustering": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # 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.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to only copy files to the destination BigLake managed table with an external storage_uri, without reading file content and writing them to new files. Copying files only is supported when: * source_uris are in the same external storage system as the destination table but they do not overlap with storage_uri of the destination table. * source_format is the same file format as the destination table. * destination_table is an existing BigLake managed table. Its schema does not have default value expression. It schema does not have type parameters other than precision and scale. * No options other than the above are specified.
"createDisposition": "A 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": True or False, # 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.
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # [Required] The destination table to load the data into.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Properties for the destination table. # Optional. [Experimental] Properties with which to create the destination table if it is new.
"description": "A 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": "A String", # Internal use only.
"friendlyName": "A String", # Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.
"labels": { # 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.
"a_key": "A String",
},
},
"encoding": "A 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": "A 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": "A String", # 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": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.
"jsonExtension": "A String", # 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": 42, # 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": "A 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.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"preserveAsciiControlCharacters": True or False, # 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": [ # 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.
"A String",
],
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"referenceFileSchemaUri": "A 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": { # Schema of a table # Optional. The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaUpdateOptions": [ # 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 two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"skipLeadingRows": 42, # 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.
"sourceFormat": "A 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": [ # [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.
"A String",
],
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useAvroLogicalTypes": True or False, # 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": "A 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_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.
},
"query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job.
"allowLargeResults": false, # 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": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # Connection properties which can modify the query behavior.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"continuous": True or False, # [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
"createDisposition": "A 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": True or False, # 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": { # Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable `@@dataset_id` achieves the same behavior. See https://cloud.google.com/bigquery/docs/reference/system-variables for more information on system variables.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": true, # 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": 1, # 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": "A String", # 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": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
"priority": "A String", # Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.
"queryParameters": [ # Query parameters for GoogleSQL queries.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts.
"keyResultStatement": "A String", # 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": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error.
"statementTimeoutMs": "A String", # Timeout period for each statement in a script.
},
"systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables.
"types": { # Output only. Data type for each system variable.
"a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } }
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE".
"structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [ # Fields within the struct.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
},
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
"values": { # Output only. Value for each system variable.
"a_key": "", # Properties of the object.
},
},
"tableDefinitions": { # 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.
"a_key": {
"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"avroOptions": { # Options for external data sources. # Optional. Additional properties to set if sourceFormat is set to AVRO.
"useAvroLogicalTypes": True or False, # 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).
},
"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE.
"columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
{ # Information related to a Bigtable column family.
"columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
{ # Information related to a Bigtable column.
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
"fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.
"onlyReadLatest": True or False, # Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.
"qualifierString": "A String", # Qualifier string.
"type": "A String", # Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
},
],
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
"familyId": "A String", # Identifier of the column family.
"onlyReadLatest": True or False, # Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
"type": "A String", # Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
},
],
"ignoreUnspecifiedColumnFamilies": True or False, # Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
"outputColumnFamiliesAsJson": True or False, # Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
"readRowkeyAsString": True or False, # Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
},
"compression": "A String", # Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.
"connectionId": "A String", # Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form "<project\_id>.<location\_id>.<connection\_id>" or "projects/<project\_id>/locations/<location\_id>/connections/<connection\_id>".
"csvOptions": { # Information related to a CSV data source. # Optional. Additional properties to set if sourceFormat is set to CSV.
"allowJaggedRows": True or False, # Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
"allowQuotedNewlines": True or False, # Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"encoding": "A 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.
"fieldDelimiter": "A 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).
"nullMarker": "A String", # [Optional] A custom string that will represent a NULL value in CSV import data.
"preserveAsciiControlCharacters": True or False, # Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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 ' "" '.
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
"googleSheetsOptions": { # Options specific to Google Sheets data sources. # Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
"range": "A String", # Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, 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.
},
"hivePartitioningOptions": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.
"jsonExtension": "A String", # 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).
"jsonOptions": { # Json Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to JSON.
"encoding": "A String", # Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
},
"maxBadRecords": 42, # Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.
"metadataCacheMode": "A String", # Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
"objectMetadata": "A String", # Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
"schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
"A String",
],
},
},
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useLegacySql": true, # Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
"useQueryCache": true, # 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": [ # Describes user-defined function resources used in the query.
{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
},
],
"writeDisposition": "A 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_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.
},
},
"etag": "A String", # Output only. A hash of this resource.
"id": "A String", # Output only. Opaque ID field of the job.
"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`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
"code": "A String", # Output only. Specifies the high level reason why a Job was created.
},
"jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job.
"jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
},
"kind": "bigquery#job", # Output only. The type of the resource.
"principal_subject": "A 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": "A String", # Output only. A URL that can be used to access the resource again.
"statistics": { # Statistics for a single job execution. # Output only. Information about the job, including starting time and ending time of the job.
"completionRatio": 3.14, # Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job.
"copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table.
"copiedRows": "A String", # Output only. Number of rows copied to the destination table.
},
"creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
"endTime": "A String", # 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": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # 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.
"A String",
],
"inputBytes": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"finalExecutionDurationMs": "A String", # 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.
"load": { # Statistics for a load job. # Output only. Statistics for a load job.
"badRecords": "A String", # 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": "A String", # Output only. Number of bytes of source data in a load job.
"inputFiles": "A String", # Output only. Number of source files in a load job.
"outputBytes": "A String", # 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": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"numChildJobs": "A String", # Output only. Number of child jobs executed.
"parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent.
"query": { # Statistics for a query job. # Output only. Statistics for a query job.
"biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics.
"accelerationMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineReasons": [ # 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.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
},
"billingTier": 42, # 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": True or False, # Output only. Whether the query result was fetched from the query cache.
"dclTargetDataset": { # Output only. Referenced dataset for DCL statement.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"dclTargetTable": { # Output only. Referenced table for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Output only. Referenced view for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
"ddlDestinationTable": { # Output only. The table after rename. Present only for ALTER TABLE RENAME TO query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
"ddlTargetDataset": { # Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"ddlTargetRoutine": { # Id path of a routine. # Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
"ddlTargetRowAccessPolicy": { # Id path of a row access policy. # Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
"datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
"policyId": "A 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": "A String", # Required. The ID of the project containing this row access policy.
"tableId": "A String", # Required. The ID of the table containing this row access policy.
},
"ddlTargetTable": { # Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
"deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
"insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
"updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.
},
"estimatedBytesProcessed": "A String", # Output only. The original estimate of bytes processed for the job.
"exportDataStatistics": { # Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. # Output only. Stats for EXPORT DATA statement.
"fileCount": "A String", # Number of destination files generated in case of EXPORT DATA statement only.
"rowCount": "A String", # [Alpha] Number of destination rows generated in case of EXPORT DATA statement only.
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
"reservedSlotCount": "A String", # 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": "A String", # External service cost in terms of bigquery slot milliseconds.
},
],
"loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query.
"badRecords": "A String", # 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": "A String", # 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": "A String", # Output only. Number of bytes of source data in a LOAD query.
"inputFiles": "A String", # Output only. Number of source files in a LOAD query.
"outputBytes": "A String", # 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": "A String", # 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": { # Statistics of materialized views considered in a query job. # Output only. Statistics of materialized views of a query job.
"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.
{ # A materialized view considered for a query job.
"chosen": True or False, # 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": "A String", # If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.
"rejectedReason": "A String", # If present, specifies the reason why the materialized view was not chosen for the query.
"tableReference": { # The candidate materialized view.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
},
],
},
"metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables.
"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query.
{ # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.
"explanation": "A String", # Free form human-readable reason metadata caching was unused for the job.
"tableReference": { # Metadata caching eligible table referenced in the query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"tableType": "A String", # [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).
"unusedReason": "A String", # Reason for not using metadata caching for the table.
},
],
},
"mlStatistics": { # Job statistics specific to a BigQuery ML training job. # Output only. Statistics of a BigQuery ML training job.
"hparamTrials": [ # Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
{ # Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.
"endTimeMs": "A String", # Ending time of the trial.
"errorMessage": "A String", # Error message for FAILED and INFEASIBLE trial.
"evalLoss": 3.14, # Loss computed on the eval data at the end of trial.
"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. # Evaluation metrics of this trial calculated on the test data. Empty in Job API.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparamTuningEvaluationMetrics": { # 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. # Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparams": { # Options used in model training. # The hyperprameters selected for this trial.
"activationFn": "A String", # Activation function of the neural nets.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"approxGlobalFeatureContrib": True or False, # Whether to use approximate feature contribution method in XGBoost model explanation for global explain.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of the sum of non-seasonal p and q.
"autoArimaMinOrder": "A String", # The min value of the sum of non-seasonal p and q.
"autoClassWeights": True or False, # Whether to calculate class weights automatically based on the popularity of each label.
"batchSize": "A String", # Batch size for dnn models.
"boosterType": "A String", # Booster type for boosted tree models.
"budgetHours": 3.14, # Budget in hours for AutoML training.
"calculatePValues": True or False, # Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.
"categoryEncodingMethod": "A String", # Categorical feature encoding method.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"colorSpace": "A String", # Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.
"colsampleBylevel": 3.14, # Subsample ratio of columns for each level for boosted tree models.
"colsampleBynode": 3.14, # Subsample ratio of columns for each node(split) for boosted tree models.
"colsampleBytree": 3.14, # Subsample ratio of columns when constructing each tree for boosted tree models.
"dartNormalizeType": "A String", # Type of normalization algorithm for boosted tree models using dart booster.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"enableGlobalExplain": True or False, # If true, enable global explanation during training.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"fitIntercept": True or False, # Whether the model should include intercept during model training.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"holidayRegions": [ # A list of geographical regions that are used for time series modeling.
"A String",
],
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for.
"A String",
],
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"instanceWeightColumn": "A String", # Name of the instance weight column for training data. This column isn't be used as a feature.
"integratedGradientsNumSteps": "A String", # Number of integral steps for the integrated gradients explain method.
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1RegActivation": 3.14, # L1 regularization coefficient to activations.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxParallelTrials": "A String", # Maximum number of trials to run in parallel.
"maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.
"minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models.
"modelRegistry": "A String", # The model registry.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"numParallelTree": "A String", # Number of parallel trees constructed during each iteration for boosted tree models.
"numPrincipalComponents": "A String", # Number of principal components to keep in the PCA model. Must be <= the number of features.
"numTrials": "A String", # Number of trials to run this hyperparameter tuning job.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"optimizer": "A String", # Optimizer used for training the neural nets.
"pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model.
"pcaSolver": "A String", # The solver for PCA.
"sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method.
"scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.
"standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"tfVersion": "A String", # Based on the selected TF version, the corresponding docker image is used to train external models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesLengthFraction": 3.14, # The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"treeMethod": "A String", # Tree construction algorithm for boosted tree models.
"trendSmoothingWindowSize": "A String", # Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.
"userColumn": "A String", # User column specified for matrix factorization models.
"vertexAiModelVersionAliases": [ # The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.
"A String",
],
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
"xgboostVersion": "A String", # User-selected XGBoost versions for training of XGBoost models.
},
"startTimeMs": "A String", # Starting time of the trial.
"status": "A String", # The status of the trial.
"trainingLoss": 3.14, # Loss computed on the training data at the end of trial.
"trialId": "A String", # 1-based index of the trial.
},
],
"iterationResults": [ # Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. # Arima result.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"principalComponentInfos": [ # The information of the principal components.
{ # Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.
"cumulativeExplainedVarianceRatio": 3.14, # The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.
"explainedVariance": 3.14, # Explained variance by this principal component, which is simply the eigenvalue.
"explainedVarianceRatio": 3.14, # Explained_variance over the total explained variance.
"principalComponentId": "A String", # Id of the principal component.
},
],
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"maxIterations": "A String", # 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": "A String", # Output only. The type of the model that is being trained.
"trainingType": "A String", # Output only. Training type of the job.
},
"modelTraining": { # Deprecated.
"currentIteration": 42, # Deprecated.
"expectedTotalIterations": "A String", # Deprecated.
},
"modelTrainingCurrentIteration": 42, # Deprecated.
"modelTrainingExpectedTotalIteration": "A String", # Deprecated.
"numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"performanceInsights": { # Performance insights for the job. # Output only. Performance insights.
"avgPreviousExecutionMs": "A String", # 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": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.
{ # Performance insights compared to the previous executions for a specific stage.
"inputDataChange": { # Details about the input data change insight. # Output only. Input data change insight of the query stage.
"recordsReadDiffPercentage": 3.14, # Output only. Records read difference percentage compared to a previous run.
},
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
"stagePerformanceStandaloneInsights": [ # Output only. Standalone query stage performance insights, for exploring potential improvements.
{ # Standalone performance insights for a specific stage.
"biEngineReasons": [ # Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
"highCardinalityJoins": [ # Output only. High cardinality joins in the stage.
{ # High cardinality join detailed information.
"leftRows": "A String", # Output only. Count of left input rows.
"outputRows": "A String", # Output only. Count of the output rows.
"rightRows": "A String", # Output only. Count of right input rows.
"stepIndex": 42, # Output only. The index of the join operator in the ExplainQueryStep lists.
},
],
"insufficientShuffleQuota": True or False, # Output only. True if the stage has insufficient shuffle quota.
"partitionSkew": { # Partition skew detailed information. # Output only. Partition skew in the stage.
"skewSources": [ # Output only. Source stages which produce skewed data.
{ # Details about source stages which produce skewed data.
"stageId": "A String", # Output only. Stage id of the skew source stage.
},
],
},
"slotContention": True or False, # Output only. True if the stage has a slot contention issue.
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
},
"queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job.
"optimizationDetails": { # Output only. Information about query optimizations.
"a_key": "", # Properties of the object.
},
},
"queryPlan": [ # Output only. Describes execution plan for the query.
{ # A single stage of query execution.
"completedParallelInputs": "A String", # Number of parallel input segments completed.
"computeMode": "A String", # Output only. Compute mode for this stage.
"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.
"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.
"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
"endMs": "A String", # Stage end time represented as milliseconds since the epoch.
"id": "A String", # Unique ID for the stage within the plan.
"inputStages": [ # IDs for stages that are inputs to this stage.
"A String",
],
"name": "A String", # Human-readable name for the stage.
"parallelInputs": "A String", # Number of parallel input segments to be processed
"readMsAvg": "A String", # Milliseconds the average shard spent reading input.
"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.
"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
"recordsRead": "A String", # Number of records read into the stage.
"recordsWritten": "A String", # Number of records written by the stage.
"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.
"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.
"slotMs": "A String", # Slot-milliseconds used by the stage.
"startMs": "A String", # Stage start time represented as milliseconds since the epoch.
"status": "A String", # Current status for this stage.
"steps": [ # List of operations within the stage in dependency order (approximately chronological).
{ # An operation within a stage.
"kind": "A String", # Machine-readable operation type.
"substeps": [ # Human-readable description of the step(s).
"A String",
],
},
],
"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.
"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.
"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.
"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.
"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
},
],
"referencedRoutines": [ # Output only. Referenced routines for the job.
{ # Id path of a routine.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
],
"referencedTables": [ # Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"schema": { # Schema of a table # Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
"sparkStatistics": { # Statistics for a BigSpark query. Populated as part of JobStatistics2 # Output only. Statistics of a Spark procedure job.
"endpoints": { # Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.
"a_key": "A String",
},
"gcsStagingBucket": "A 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": "A 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": { # Spark job logs can be filtered by these fields in Cloud Logging. # Output only. Logging info is used to generate a link to Cloud Logging.
"projectId": "A String", # Output only. Project ID where the Spark logs were written.
"resourceType": "A String", # Output only. Resource type used for logging.
},
"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully.
"sparkJobLocation": "A 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": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement.
"timeline": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
"totalBytesBilled": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A 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": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
},
"quotaDeferments": [ # Output only. Quotas which delayed this job's start time.
"A String",
],
"reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"reservation_id": "A 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": { # Statistics for row-level security. # Output only. Statistics for row-level security. Present only for query and extract jobs.
"rowLevelSecurityApplied": True or False, # Whether any accessed data was protected by row access policies.
},
"scriptStatistics": { # Job statistics specific to the child job of a script. # Output only. If this a child job of a script, specifies information about the context of this job within the script.
"evaluationKind": "A String", # Whether this child job was a statement or expression.
"stackFrames": [ # 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.
{ # Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a ";", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab "snaps" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.
"endColumn": 42, # Output only. One-based end column.
"endLine": 42, # Output only. One-based end line.
"procedureId": "A String", # Output only. Name of the active procedure, empty if in a top-level script.
"startColumn": 42, # Output only. One-based start column.
"startLine": 42, # Output only. One-based start line.
"text": "A String", # Output only. Text of the current statement/expression.
},
],
},
"sessionInfo": { # [Preview] Information related to sessions. # Output only. Information of the session if this job is part of one.
"sessionId": "A String", # Output only. The id of the session.
},
"startTime": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transactionInfo": { # [Alpha] Information of a multi-statement transaction. # Output only. [Alpha] Information of the multi-statement transaction if this job is part of one. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
"transactionId": "A String", # Output only. [Alpha] Id of the transaction.
},
},
"status": { # Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
"errorResult": { # Error details. # Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
"errors": [ # 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.
{ # Error details.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
],
"state": "A String", # Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.
},
"user_email": "A String", # Output only. Email address of the user who ran the job.
}

list(projectId, allUsers=None, maxCreationTime=None, maxResults=None, minCreationTime=None, pageToken=None, parentJobId=None, projection=None, stateFilter=None, x__xgafv=None)

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

Args:
projectId: string, Project ID of the jobs to list. (required)
allUsers: boolean, Whether to display jobs owned by all users in the project. Default False.
maxCreationTime: string, Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.
maxResults: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
minCreationTime: string, Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
parentJobId: string, If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.
projection: string, Restrict information returned to a set of selected fields
Allowed values
full - Includes all job data
minimal - Does not include the job configuration
stateFilter: string, Filter for job state (repeated)
Allowed values
done - Finished jobs
pending - Pending jobs
running - Running jobs
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # JobList is the response format for a jobs.list call.
"etag": "A String", # A hash of this page of results.
"jobs": [ # List of jobs that were requested.
{ # ListFormatJob is a partial projection of job information returned as part of a jobs.list response.
"configuration": { # Required. Describes the job configuration.
"copy": { # 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). # [Pick one] Copies a table.
"createDisposition": "A 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": { # Custom encryption configuration (e.g., Cloud KMS keys).
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationExpirationTime": "A String", # Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
"destinationTable": { # [Required] The destination table.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Optional. Supported operation types in table copy job.
"sourceTable": { # [Pick one] Source table to copy.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # [Pick one] Source tables to copy.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A 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": True or False, # 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 configures a job that exports data from a BigQuery table into Google Cloud Storage. # [Pick one] Configures an extract job.
"compression": "A 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": "A 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": "A 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": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
"A String",
],
"fieldDelimiter": "A 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": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models.
"trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.
},
"printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
"sourceModel": { # Id path of a model. # A reference to the model being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this model.
"modelId": "A 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": "A String", # Required. The ID of the project containing this model.
},
"sourceTable": { # A reference to the table being exported.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.
},
"jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.
"jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
"labels": { # 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.
"a_key": "A String",
},
"load": { # JobConfigurationLoad contains the configuration properties for loading data into a destination table. # [Pick one] Configures a load job.
"allowJaggedRows": True or False, # 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": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"autodetect": True or False, # Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"clustering": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # 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.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"copyFilesOnly": True or False, # Optional. [Experimental] Configures the load job to only copy files to the destination BigLake managed table with an external storage_uri, without reading file content and writing them to new files. Copying files only is supported when: * source_uris are in the same external storage system as the destination table but they do not overlap with storage_uri of the destination table. * source_format is the same file format as the destination table. * destination_table is an existing BigLake managed table. Its schema does not have default value expression. It schema does not have type parameters other than precision and scale. * No options other than the above are specified.
"createDisposition": "A 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": True or False, # 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.
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # [Required] The destination table to load the data into.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Properties for the destination table. # Optional. [Experimental] Properties with which to create the destination table if it is new.
"description": "A 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": "A String", # Internal use only.
"friendlyName": "A String", # Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.
"labels": { # 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.
"a_key": "A String",
},
},
"encoding": "A 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": "A 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": "A String", # 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": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.
"jsonExtension": "A String", # 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": 42, # 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": "A 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.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"preserveAsciiControlCharacters": True or False, # 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": [ # 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.
"A String",
],
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"referenceFileSchemaUri": "A 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": { # Schema of a table # Optional. The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaUpdateOptions": [ # 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 two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"skipLeadingRows": 42, # 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.
"sourceFormat": "A 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": [ # [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.
"A String",
],
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useAvroLogicalTypes": True or False, # 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": "A 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_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.
},
"query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job.
"allowLargeResults": false, # 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": { # Configures table clustering. # Clustering specification for the destination table.
"fields": [ # 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. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
"A String",
],
},
"connectionProperties": [ # Connection properties which can modify the query behavior.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"continuous": True or False, # [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
"createDisposition": "A 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": True or False, # 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": { # Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable `@@dataset_id` achieves the same behavior. See https://cloud.google.com/bigquery/docs/reference/system-variables for more information on system variables.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys)
"kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"destinationTable": { # Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": true, # 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": 1, # 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": "A String", # 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": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
"priority": "A String", # Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.
"queryParameters": [ # Query parameters for GoogleSQL queries.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
"range": { # [Experimental] Defines the ranges for range partitioning.
"end": "A String", # [Experimental] The end of range partitioning, exclusive.
"interval": "A String", # [Experimental] The width of each interval.
"start": "A String", # [Experimental] The start of range partitioning, inclusive.
},
},
"schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; 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.
"A String",
],
"scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts.
"keyResultStatement": "A String", # 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": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error.
"statementTimeoutMs": "A String", # Timeout period for each statement in a script.
},
"systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables.
"types": { # Output only. Data type for each system variable.
"a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } }
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE".
"structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [ # Fields within the struct.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
},
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
"values": { # Output only. Value for each system variable.
"a_key": "", # Properties of the object.
},
},
"tableDefinitions": { # 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.
"a_key": {
"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"avroOptions": { # Options for external data sources. # Optional. Additional properties to set if sourceFormat is set to AVRO.
"useAvroLogicalTypes": True or False, # 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).
},
"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE.
"columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
{ # Information related to a Bigtable column family.
"columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
{ # Information related to a Bigtable column.
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
"fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.
"onlyReadLatest": True or False, # Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.
"qualifierString": "A String", # Qualifier string.
"type": "A String", # Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
},
],
"encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
"familyId": "A String", # Identifier of the column family.
"onlyReadLatest": True or False, # Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
"type": "A String", # Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
},
],
"ignoreUnspecifiedColumnFamilies": True or False, # Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
"outputColumnFamiliesAsJson": True or False, # Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
"readRowkeyAsString": True or False, # Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
},
"compression": "A String", # Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.
"connectionId": "A String", # Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form "<project\_id>.<location\_id>.<connection\_id>" or "projects/<project\_id>/locations/<location\_id>/connections/<connection\_id>".
"csvOptions": { # Information related to a CSV data source. # Optional. Additional properties to set if sourceFormat is set to CSV.
"allowJaggedRows": True or False, # Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
"allowQuotedNewlines": True or False, # Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
"encoding": "A 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.
"fieldDelimiter": "A 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).
"nullMarker": "A String", # [Optional] A custom string that will represent a NULL value in CSV import data.
"preserveAsciiControlCharacters": True or False, # Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
"quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. 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 ' "" '.
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
"decimalTargetTypes": [ # 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 exeeds 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.
"A String",
],
"fileSetSpecType": "A String", # Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
"googleSheetsOptions": { # Options specific to Google Sheets data sources. # Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
"range": "A String", # Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
"skipLeadingRows": "A String", # Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, 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.
},
"hivePartitioningOptions": { # Options for configuring hive partitioning detect. # Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
"fields": [ # 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.
"A String",
],
"mode": "A 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": false, # Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
"sourceUriPrefix": "A 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": True or False, # Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.
"jsonExtension": "A String", # 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).
"jsonOptions": { # Json Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to JSON.
"encoding": "A String", # Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
},
"maxBadRecords": 42, # Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.
"metadataCacheMode": "A String", # Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
"objectMetadata": "A String", # Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.
"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET.
"enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
"enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
},
"referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
"schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
"A String",
],
},
},
"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
"expirationMs": "A String", # 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": "A 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": false, # 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": "A String", # Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
},
"useLegacySql": true, # Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
"useQueryCache": true, # 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": [ # Describes user-defined function resources used in the query.
{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
},
],
"writeDisposition": "A 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_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.
},
},
"errorResult": { # Error details. # A result object that will be present only if the job has failed.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
"id": "A String", # Unique opaque ID of the job.
"jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Unique opaque ID of the job.
"jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
},
"kind": "A String", # The resource type.
"principal_subject": "A String", # [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.
"state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
"statistics": { # Statistics for a single job execution. # Output only. Information about the job, including starting time and ending time of the job.
"completionRatio": 3.14, # Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job.
"copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table.
"copiedRows": "A String", # Output only. Number of rows copied to the destination table.
},
"creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
"endTime": "A String", # 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": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # 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.
"A String",
],
"inputBytes": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"finalExecutionDurationMs": "A String", # 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.
"load": { # Statistics for a load job. # Output only. Statistics for a load job.
"badRecords": "A String", # 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": "A String", # Output only. Number of bytes of source data in a load job.
"inputFiles": "A String", # Output only. Number of source files in a load job.
"outputBytes": "A String", # 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": "A String", # 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": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
},
"numChildJobs": "A String", # Output only. Number of child jobs executed.
"parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent.
"query": { # Statistics for a query job. # Output only. Statistics for a query job.
"biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics.
"accelerationMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineMode": "A String", # Output only. Specifies which mode of BI Engine acceleration was performed (if any).
"biEngineReasons": [ # 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.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
},
"billingTier": 42, # 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": True or False, # Output only. Whether the query result was fetched from the query cache.
"dclTargetDataset": { # Output only. Referenced dataset for DCL statement.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"dclTargetTable": { # Output only. Referenced table for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Output only. Referenced view for DCL statement.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
"ddlDestinationTable": { # Output only. The table after rename. Present only for ALTER TABLE RENAME TO query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": "A String", # Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
"ddlTargetDataset": { # Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"ddlTargetRoutine": { # Id path of a routine. # Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
"ddlTargetRowAccessPolicy": { # Id path of a row access policy. # Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
"datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
"policyId": "A 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": "A String", # Required. The ID of the project containing this row access policy.
"tableId": "A String", # Required. The ID of the table containing this row access policy.
},
"ddlTargetTable": { # Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
"deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
"insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
"updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.
},
"estimatedBytesProcessed": "A String", # Output only. The original estimate of bytes processed for the job.
"exportDataStatistics": { # Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. # Output only. Stats for EXPORT DATA statement.
"fileCount": "A String", # Number of destination files generated in case of EXPORT DATA statement only.
"rowCount": "A String", # [Alpha] Number of destination rows generated in case of EXPORT DATA statement only.
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
"reservedSlotCount": "A String", # 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": "A String", # External service cost in terms of bigquery slot milliseconds.
},
],
"loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query.
"badRecords": "A String", # 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": "A String", # 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": "A String", # Output only. Number of bytes of source data in a LOAD query.
"inputFiles": "A String", # Output only. Number of source files in a LOAD query.
"outputBytes": "A String", # 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": "A String", # 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": { # Statistics of materialized views considered in a query job. # Output only. Statistics of materialized views of a query job.
"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.
{ # A materialized view considered for a query job.
"chosen": True or False, # 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": "A String", # If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.
"rejectedReason": "A String", # If present, specifies the reason why the materialized view was not chosen for the query.
"tableReference": { # The candidate materialized view.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
},
],
},
"metadataCacheStatistics": { # Statistics for metadata caching in BigLake tables. # Output only. Statistics of metadata cache usage in a query for BigLake tables.
"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query.
{ # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.
"explanation": "A String", # Free form human-readable reason metadata caching was unused for the job.
"tableReference": { # Metadata caching eligible table referenced in the query.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"tableType": "A String", # [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).
"unusedReason": "A String", # Reason for not using metadata caching for the table.
},
],
},
"mlStatistics": { # Job statistics specific to a BigQuery ML training job. # Output only. Statistics of a BigQuery ML training job.
"hparamTrials": [ # Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
{ # Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.
"endTimeMs": "A String", # Ending time of the trial.
"errorMessage": "A String", # Error message for FAILED and INFEASIBLE trial.
"evalLoss": 3.14, # Loss computed on the eval data at the end of trial.
"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. # Evaluation metrics of this trial calculated on the test data. Empty in Job API.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparamTuningEvaluationMetrics": { # 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. # Hyperparameter tuning evaluation metrics of this trial calculated on the eval data. Unlike evaluation_metrics, only the fields corresponding to the hparam_tuning_objectives are set.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"dimensionalityReductionMetrics": { # Model evaluation metrics for dimensionality reduction models. # Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
"totalExplainedVarianceRatio": 3.14, # Total percentage of variance explained by the selected principal components.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"hparams": { # Options used in model training. # The hyperprameters selected for this trial.
"activationFn": "A String", # Activation function of the neural nets.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"approxGlobalFeatureContrib": True or False, # Whether to use approximate feature contribution method in XGBoost model explanation for global explain.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of the sum of non-seasonal p and q.
"autoArimaMinOrder": "A String", # The min value of the sum of non-seasonal p and q.
"autoClassWeights": True or False, # Whether to calculate class weights automatically based on the popularity of each label.
"batchSize": "A String", # Batch size for dnn models.
"boosterType": "A String", # Booster type for boosted tree models.
"budgetHours": 3.14, # Budget in hours for AutoML training.
"calculatePValues": True or False, # Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.
"categoryEncodingMethod": "A String", # Categorical feature encoding method.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"colorSpace": "A String", # Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.
"colsampleBylevel": 3.14, # Subsample ratio of columns for each level for boosted tree models.
"colsampleBynode": 3.14, # Subsample ratio of columns for each node(split) for boosted tree models.
"colsampleBytree": 3.14, # Subsample ratio of columns when constructing each tree for boosted tree models.
"dartNormalizeType": "A String", # Type of normalization algorithm for boosted tree models using dart booster.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"enableGlobalExplain": True or False, # If true, enable global explanation during training.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"fitIntercept": True or False, # Whether the model should include intercept during model training.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"holidayRegions": [ # A list of geographical regions that are used for time series modeling.
"A String",
],
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for.
"A String",
],
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"instanceWeightColumn": "A String", # Name of the instance weight column for training data. This column isn't be used as a feature.
"integratedGradientsNumSteps": "A String", # Number of integral steps for the integrated gradients explain method.
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1RegActivation": 3.14, # L1 regularization coefficient to activations.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxParallelTrials": "A String", # Maximum number of trials to run in parallel.
"maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.
"minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models.
"modelRegistry": "A String", # The model registry.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"numParallelTree": "A String", # Number of parallel trees constructed during each iteration for boosted tree models.
"numPrincipalComponents": "A String", # Number of principal components to keep in the PCA model. Must be <= the number of features.
"numTrials": "A String", # Number of trials to run this hyperparameter tuning job.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"optimizer": "A String", # Optimizer used for training the neural nets.
"pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model.
"pcaSolver": "A String", # The solver for PCA.
"sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method.
"scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.
"standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"tfVersion": "A String", # Based on the selected TF version, the corresponding docker image is used to train external models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesLengthFraction": 3.14, # The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"treeMethod": "A String", # Tree construction algorithm for boosted tree models.
"trendSmoothingWindowSize": "A String", # Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.
"userColumn": "A String", # User column specified for matrix factorization models.
"vertexAiModelVersionAliases": [ # The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.
"A String",
],
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
"xgboostVersion": "A String", # User-selected XGBoost versions for training of XGBoost models.
},
"startTimeMs": "A String", # Starting time of the trial.
"status": "A String", # The status of the trial.
"trainingLoss": 3.14, # Loss computed on the training data at the end of trial.
"trialId": "A String", # 1-based index of the trial.
},
],
"iterationResults": [ # Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. # Arima result.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"principalComponentInfos": [ # The information of the principal components.
{ # Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.
"cumulativeExplainedVarianceRatio": 3.14, # The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.
"explainedVariance": 3.14, # Explained variance by this principal component, which is simply the eigenvalue.
"explainedVarianceRatio": 3.14, # Explained_variance over the total explained variance.
"principalComponentId": "A String", # Id of the principal component.
},
],
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"maxIterations": "A String", # 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": "A String", # Output only. The type of the model that is being trained.
"trainingType": "A String", # Output only. Training type of the job.
},
"modelTraining": { # Deprecated.
"currentIteration": 42, # Deprecated.
"expectedTotalIterations": "A String", # Deprecated.
},
"modelTrainingCurrentIteration": 42, # Deprecated.
"modelTrainingExpectedTotalIteration": "A String", # Deprecated.
"numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"performanceInsights": { # Performance insights for the job. # Output only. Performance insights.
"avgPreviousExecutionMs": "A String", # 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": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.
{ # Performance insights compared to the previous executions for a specific stage.
"inputDataChange": { # Details about the input data change insight. # Output only. Input data change insight of the query stage.
"recordsReadDiffPercentage": 3.14, # Output only. Records read difference percentage compared to a previous run.
},
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
"stagePerformanceStandaloneInsights": [ # Output only. Standalone query stage performance insights, for exploring potential improvements.
{ # Standalone performance insights for a specific stage.
"biEngineReasons": [ # Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.
{ # Reason why BI Engine didn't accelerate the query (or sub-query).
"code": "A String", # Output only. High-level BI Engine reason for partial or disabled acceleration
"message": "A String", # Output only. Free form human-readable reason for partial or disabled acceleration.
},
],
"highCardinalityJoins": [ # Output only. High cardinality joins in the stage.
{ # High cardinality join detailed information.
"leftRows": "A String", # Output only. Count of left input rows.
"outputRows": "A String", # Output only. Count of the output rows.
"rightRows": "A String", # Output only. Count of right input rows.
"stepIndex": 42, # Output only. The index of the join operator in the ExplainQueryStep lists.
},
],
"insufficientShuffleQuota": True or False, # Output only. True if the stage has insufficient shuffle quota.
"partitionSkew": { # Partition skew detailed information. # Output only. Partition skew in the stage.
"skewSources": [ # Output only. Source stages which produce skewed data.
{ # Details about source stages which produce skewed data.
"stageId": "A String", # Output only. Stage id of the skew source stage.
},
],
},
"slotContention": True or False, # Output only. True if the stage has a slot contention issue.
"stageId": "A String", # Output only. The stage id that the insight mapped to.
},
],
},
"queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job.
"optimizationDetails": { # Output only. Information about query optimizations.
"a_key": "", # Properties of the object.
},
},
"queryPlan": [ # Output only. Describes execution plan for the query.
{ # A single stage of query execution.
"completedParallelInputs": "A String", # Number of parallel input segments completed.
"computeMode": "A String", # Output only. Compute mode for this stage.
"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.
"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.
"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
"endMs": "A String", # Stage end time represented as milliseconds since the epoch.
"id": "A String", # Unique ID for the stage within the plan.
"inputStages": [ # IDs for stages that are inputs to this stage.
"A String",
],
"name": "A String", # Human-readable name for the stage.
"parallelInputs": "A String", # Number of parallel input segments to be processed
"readMsAvg": "A String", # Milliseconds the average shard spent reading input.
"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.
"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
"recordsRead": "A String", # Number of records read into the stage.
"recordsWritten": "A String", # Number of records written by the stage.
"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.
"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.
"slotMs": "A String", # Slot-milliseconds used by the stage.
"startMs": "A String", # Stage start time represented as milliseconds since the epoch.
"status": "A String", # Current status for this stage.
"steps": [ # List of operations within the stage in dependency order (approximately chronological).
{ # An operation within a stage.
"kind": "A String", # Machine-readable operation type.
"substeps": [ # Human-readable description of the step(s).
"A String",
],
},
],
"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.
"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.
"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.
"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.
"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
},
],
"referencedRoutines": [ # Output only. Referenced routines for the job.
{ # Id path of a routine.
"datasetId": "A String", # Required. The ID of the dataset containing this routine.
"projectId": "A String", # Required. The ID of the project containing this routine.
"routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
},
],
"referencedTables": [ # Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"schema": { # Schema of a table # Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
"sparkStatistics": { # Statistics for a BigSpark query. Populated as part of JobStatistics2 # Output only. Statistics of a Spark procedure job.
"endpoints": { # Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.
"a_key": "A String",
},
"gcsStagingBucket": "A 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": "A 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": { # Spark job logs can be filtered by these fields in Cloud Logging. # Output only. Logging info is used to generate a link to Cloud Logging.
"projectId": "A String", # Output only. Project ID where the Spark logs were written.
"resourceType": "A String", # Output only. Resource type used for logging.
},
"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully.
"sparkJobLocation": "A 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": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement.
"timeline": [ # Output only. Describes a timeline of job execution.
{ # Summary of the state of query execution at a given time.
"activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
"completedUnits": "A String", # Total parallel units of work completed by this query.
"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.
"estimatedRunnableUnits": "A String", # 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": "A String", # Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.
},
],
"totalBytesBilled": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A 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": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics.
"indexUnusedReasons": [ # 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.
{ # Reason about why no search index was used in the search query (or sub-query).
"baseTable": { # Specifies the base table involved in the reason that no search index was used.
"datasetId": "A String", # Required. The ID of the dataset containing this table.
"projectId": "A String", # Required. The ID of the project containing this table.
"tableId": "A 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`.
},
"code": "A String", # Specifies the high-level reason for the scenario when no search index was used.
"indexName": "A String", # Specifies the name of the unused search index, if available.
"message": "A String", # Free form human-readable reason for the scenario when no search index was used.
},
],
"indexUsageMode": "A String", # Specifies the index usage mode for the query.
},
},
"quotaDeferments": [ # Output only. Quotas which delayed this job's start time.
"A String",
],
"reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
{ # Job resource usage breakdown by reservation.
"name": "A String", # Reservation name or "unreserved" for on-demand resources usage.
"slotMs": "A String", # Total slot milliseconds used by the reservation for a particular job.
},
],
"reservation_id": "A 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": { # Statistics for row-level security. # Output only. Statistics for row-level security. Present only for query and extract jobs.
"rowLevelSecurityApplied": True or False, # Whether any accessed data was protected by row access policies.
},
"scriptStatistics": { # Job statistics specific to the child job of a script. # Output only. If this a child job of a script, specifies information about the context of this job within the script.
"evaluationKind": "A String", # Whether this child job was a statement or expression.
"stackFrames": [ # 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.
{ # Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a ";", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab "snaps" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.
"endColumn": 42, # Output only. One-based end column.
"endLine": 42, # Output only. One-based end line.
"procedureId": "A String", # Output only. Name of the active procedure, empty if in a top-level script.
"startColumn": 42, # Output only. One-based start column.
"startLine": 42, # Output only. One-based start line.
"text": "A String", # Output only. Text of the current statement/expression.
},
],
},
"sessionInfo": { # [Preview] Information related to sessions. # Output only. Information of the session if this job is part of one.
"sessionId": "A String", # Output only. The id of the session.
},
"startTime": "A String", # 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": "A String", # Output only. Total bytes processed for the job.
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transactionInfo": { # [Alpha] Information of a multi-statement transaction. # Output only. [Alpha] Information of the multi-statement transaction if this job is part of one. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
"transactionId": "A String", # Output only. [Alpha] Id of the transaction.
},
},
"status": { # [Full-projection-only] Describes the status of this job.
"errorResult": { # Error details. # Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
"errors": [ # 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.
{ # Error details.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
],
"state": "A String", # Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.
},
"user_email": "A String", # [Full-projection-only] Email address of the user who ran the job.
},
],
"kind": "bigquery#jobList", # The resource type of the response.
"nextPageToken": "A String", # A token to request the next page of results.
"unreachable": [ # A list of skipped locations that were unreachable. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations. Example: "europe-west5"
"A String",
],
}

list_next()

Retrieves the next page of results.

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

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

query(projectId, body=None, x__xgafv=None)

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

Args:
projectId: string, Required. Project ID of the query request. (required)
body: object, The request body.
The object takes the form of:

{ # Describes the format of the jobs.query request.
"connectionProperties": [ # Optional. Connection properties which can modify the query behavior.
{ # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.
"key": "A String", # The key of the property to set.
"value": "A String", # The value of the property to set.
},
],
"continuous": True or False, # [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
"createSession": True or False, # Optional. If true, creates a new session using a randomly generated session_id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. The session location will be set to QueryRequest.location if it is present, otherwise it's set to the default location based on existing routing logic.
"defaultDataset": { # Optional. Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # Optional. The ID of the project containing this dataset.
},
"dryRun": True or False, # Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
"formatOptions": { # Options for data format adjustments. # Optional. Output format adjustments.
"useInt64Timestamp": True or False, # Optional. Output timestamp as usec int64. Default is false.
},
"jobCreationMode": "A String", # Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. This feature is not yet available. Jobs will always be created.
"kind": "bigquery#queryRequest", # The resource type of the request.
"labels": { # Optional. The labels associated with this query. Labels can be used to organize and group query 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 keys must start with a letter and each label in the list must have a different key.
"a_key": "A String",
},
"location": "A String", # The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
"maxResults": 42, # Optional. The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.
"maximumBytesBilled": "A String", # Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used.
"parameterMode": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"preserveNulls": True or False, # This property is deprecated.
"query": "A String", # Required. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: "SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId".
"queryParameters": [ # Query parameters for GoogleSQL queries.
{ # A parameter given to a query.
"name": "A String", # Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
"parameterType": { # The type of a query parameter. # Required. The type of this parameter.
"arrayType": # Object with schema name: QueryParameterType # Optional. The type of the array's elements, if this is an array.
"rangeElementType": # Object with schema name: QueryParameterType # Optional. The element type of the range, if this is a range.
"structTypes": [ # Optional. The types of the fields of this struct, in order, if this is a struct.
{ # The type of a struct parameter.
"description": "A String", # Optional. Human-oriented description of the field.
"name": "A String", # Optional. The name of this field.
"type": # Object with schema name: QueryParameterType # Required. The type of this field.
},
],
"type": "A String", # Required. The top level type of this field.
},
"parameterValue": { # The value of a query parameter. # Required. The value of this parameter.
"arrayValues": [ # Optional. The array values, if this is an array type.
# Object with schema name: QueryParameterValue
],
"rangeValue": { # Represents the value of a range. # Optional. The range value, if this is a range type.
"end": # Object with schema name: QueryParameterValue # Optional. The end value of the range. A missing value represents an unbounded end.
"start": # Object with schema name: QueryParameterValue # Optional. The start value of the range. A missing value represents an unbounded start.
},
"structValues": { # The struct field values.
"a_key": # Object with schema name: QueryParameterValue
},
"value": "A String", # Optional. The value of this value, if a simple scalar type.
},
},
],
"requestId": "A String", # Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.
"timeoutMs": 42, # Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.
"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
"useQueryCache": true, # 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. The default value is true.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"cacheHit": True or False, # Whether the query result was fetched from the query cache.
"dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
"deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
"insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
"updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.
},
"errors": [ # Output only. The first errors or warnings 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 completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).
{ # Error details.
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
"location": "A String", # Specifies where the error occurred, if present.
"message": "A String", # A human-readable description of the error.
"reason": "A String", # A short error code that summarizes the error.
},
],
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
"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`. This feature is not yet available. Jobs will always be created. # Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
"code": "A String", # Output only. Specifies the high level reason why a Job was created.
},
"jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
"jobId": "A 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": "A 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": "A String", # Required. The ID of the project containing this job.
},
"kind": "bigquery#queryResponse", # The resource type.
"numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"pageToken": "A String", # A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results).
"queryId": "A String", # Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated.
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
{
"f": [ # Represents a single row in the result set, consisting of one or more fields.
{
"v": "",
},
],
},
],
"schema": { # Schema of a table # The schema of the results. Present only when the query completes successfully.
"fields": [ # Describes the fields in a table.
{ # A field in TableSchema
"categories": { # Deprecated.
"names": [ # Deprecated.
"A String",
],
},
"collation": "A 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.
"defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
"description": "A String", # Optional. The field description. The maximum length is 1,024 characters.
"fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD.
# Object with schema name: TableFieldSchema
],
"maxLength": "A String", # 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": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
"name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
"policyTags": { # Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
"names": [ # A list of policy tag resource names. For example, "projects/1/locations/eu/taxonomies/2/policyTags/3". At most 1 policy tag is currently allowed.
"A String",
],
},
"precision": "A String", # 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": { # Represents the type of a field element.
"type": "A String", # Required. The type of a field element. For more information, see TableFieldSchema.type.
},
"roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
"scale": "A String", # Optional. See documentation for precision.
"type": "A 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 ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.
},
],
},
"sessionInfo": { # [Preview] Information related to sessions. # Output only. Information of the session if this job is part of one.
"sessionId": "A String", # Output only. The id of the session.
},
"totalBytesProcessed": "A String", # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
}

BigQuery API . jobs

Instance Methods

Method Details