Types overview

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.

Fields
accuracy	number (double format) Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
f1Score	number (double format) The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
logLoss	number (double format) Logarithmic Loss. For multiclass this is a macro-averaged metric.
precision	number (double format) 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	number (double format) Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
rocAuc	number (double format) Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
threshold	number (double format) Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold.

AggregationThresholdPolicy

Represents privacy policy associated with "aggregation threshold" method.

Fields
privacyUnitColumns[]	string Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner")
threshold	string (int64 format) Optional. The threshold for the "aggregation threshold" policy.

Argument

Input/output argument of a function or a stored procedure.

Fields
argumentKind	enum Optional. Defaults to FIXED_TYPE.
Enum type. Can be one of the following:
ARGUMENT_KIND_UNSPECIFIED	Default value.
FIXED_TYPE	The argument is a variable with fully specified type, which can be a struct or an array, but not a table.
ANY_TYPE	The argument is any type, including struct or array, but not a table.
FIXED_TABLE	The argument is a table with fully specified column names and types.
ANY_TABLE	The argument is any table type.
dataType	object (StandardSqlDataType) Set if argument_kind == FIXED_TYPE.
isAggregate	boolean Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL.
mode	enum Optional. Specifies whether the argument is input or output. Can be set for procedures only.
Enum type. Can be one of the following:
MODE_UNSPECIFIED	Default value.
IN	The argument is input-only.
OUT	The argument is output-only.
INOUT	The argument is both an input and an output.
name	string Optional. The name of this argument. Can be absent for function return argument.
tableType	object (StandardSqlTableType) Optional. Set if argument_kind == FIXED_TABLE.

ArimaCoefficients

Arima coefficients.

Fields
autoRegressiveCoefficients[]	number (double format) Auto-regressive coefficients, an array of double.
interceptCoefficient	number (double format) Intercept coefficient, just a double not an array.
movingAverageCoefficients[]	number (double format) Moving-average coefficients, an array of double.

ArimaFittingMetrics

ARIMA model fitting metrics.

Fields
aic	number (double format) AIC.
logLikelihood	number (double format) Log-likelihood.
variance	number (double format) Variance.

ArimaForecastingMetrics

Model evaluation metrics for ARIMA forecasting models.

Fields
arimaFittingMetrics[]	object (ArimaFittingMetrics) Arima model fitting metrics.
arimaSingleModelForecastingMetrics[]	object (ArimaSingleModelForecastingMetrics) Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
hasDrift[]	boolean Whether Arima model fitted with drift or not. It is always false when d is not 1.
nonSeasonalOrder[]	object (ArimaOrder) Non-seasonal order.
seasonalPeriods[]	string Seasonal periods. Repeated because multiple periods are supported for one time series.
timeSeriesId[]	string Id to differentiate different time series for the large-scale case.

ArimaModelInfo

Arima model information.

Fields
arimaCoefficients	object (ArimaCoefficients) Arima coefficients.
arimaFittingMetrics	object (ArimaFittingMetrics) Arima fitting metrics.
hasDrift	boolean Whether Arima model fitted with drift or not. It is always false when d is not 1.
hasHolidayEffect	boolean If true, holiday_effect is a part of time series decomposition result.
hasSpikesAndDips	boolean If true, spikes_and_dips is a part of time series decomposition result.
hasStepChanges	boolean If true, step_changes is a part of time series decomposition result.
nonSeasonalOrder	object (ArimaOrder) Non-seasonal order.
seasonalPeriods[]	string Seasonal periods. Repeated because multiple periods are supported for one time series.
timeSeriesId	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[]	string 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.

ArimaOrder

Arima order, can be used for both non-seasonal and seasonal parts.

Fields
d	string (int64 format) Order of the differencing part.
p	string (int64 format) Order of the autoregressive part.
q	string (int64 format) Order of the moving-average part.

ArimaResult

(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.

Fields
arimaModelInfo[]	object (ArimaModelInfo) This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
seasonalPeriods[]	string Seasonal periods. Repeated because multiple periods are supported for one time series.

ArimaSingleModelForecastingMetrics

Model evaluation metrics for a single ARIMA forecasting model.

Fields
arimaFittingMetrics	object (ArimaFittingMetrics) Arima fitting metrics.
hasDrift	boolean Is arima model fitted with drift or not. It is always false when d is not 1.
hasHolidayEffect	boolean If true, holiday_effect is a part of time series decomposition result.
hasSpikesAndDips	boolean If true, spikes_and_dips is a part of time series decomposition result.
hasStepChanges	boolean If true, step_changes is a part of time series decomposition result.
nonSeasonalOrder	object (ArimaOrder) Non-seasonal order.
seasonalPeriods[]	string Seasonal periods. Repeated because multiple periods are supported for one time series.
timeSeriesId	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[]	string 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.

ArrowRecordBatch

Arrow RecordBatch. This feature is not yet available.

Fields
serializedRecordBatch	string (bytes format) IPC-serialized Arrow RecordBatch.

ArrowSchema

Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available.

Fields
serializedSchema	string (bytes format) IPC serialized Arrow schema.

ArrowSerializationOptions

Contains options specific to Arrow Serialization. This feature is not yet available.

Fields
bufferCompression	enum The compression codec to use for Arrow buffers in serialized record batches.
Enum type. Can be one of the following:
COMPRESSION_UNSPECIFIED	If unspecified no compression will be used.
LZ4_FRAME	LZ4 Frame (https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md)
ZSTD	Zstandard compression.
picosTimestampPrecision	enum Optional. Set timestamp precision option. If not set, the default precision is microseconds.
Enum type. Can be one of the following:
PICOS_TIMESTAMP_PRECISION_UNSPECIFIED	Unspecified timestamp precision. The default precision is microseconds.
TIMESTAMP_PRECISION_MICROS	Timestamp values returned in the results will be truncated to microsecond level precision. The value will be encoded as Arrow TIMESTAMP type in a 64 bit integer.
TIMESTAMP_PRECISION_NANOS	Timestamp values returned in the results will be truncated to nanosecond level precision. The value will be encoded as Arrow TIMESTAMP type in a 64 bit integer.
TIMESTAMP_PRECISION_PICOS	Timestamp values returned in the results will contain full precision picosecond value. The value will be encoded as a string which conforms to ISO 8601 format.

AuditConfig

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

Fields
auditLogConfigs[]	object (AuditLogConfig) The configuration for logging of each type of permission.
service	string Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[e-mail]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [e-mail] from DATA_READ logging.

Fields
exemptedMembers[]	string Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
logType	enum The log type that this config enables.
Enum type. Can be one of the following:
LOG_TYPE_UNSPECIFIED	Default case. Should never be this.
ADMIN_READ	Admin reads. Example: CloudIAM getIamPolicy
DATA_WRITE	Data writes. Example: CloudSQL Users create
DATA_READ	Data reads. Example: CloudSQL Users list

AvroOptions

Options for external data sources.

Fields
useAvroLogicalTypes	boolean Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).

BatchDeleteRowAccessPoliciesRequest

Request message for the BatchDeleteRowAccessPoliciesRequest method.

Fields
force	boolean If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.
policyIds[]	string Required. Policy IDs of the row access policies.

BiEngineReason

Reason why BI Engine didn't accelerate the query (or sub-query).

Fields
code	enum Output only. High-level BI Engine reason for partial or disabled acceleration
Enum type. Can be one of the following:
CODE_UNSPECIFIED	BiEngineReason not specified.
NO_RESERVATION	No reservation available for BI Engine acceleration.
INSUFFICIENT_RESERVATION	Not enough memory available for BI Engine acceleration.
UNSUPPORTED_SQL_TEXT	This particular SQL text is not supported for acceleration by BI Engine.
INPUT_TOO_LARGE	Input too large for acceleration by BI Engine.
OTHER_REASON	Catch-all code for all other cases for partial or disabled acceleration.
TABLE_EXCLUDED	One or more tables were not eligible for BI Engine acceleration.
message	string Output only. Free form human-readable reason for partial or disabled acceleration.

BiEngineStatistics

Statistics for a BI Engine specific query. Populated as part of JobStatistics2

Fields
accelerationMode	enum Output only. Specifies which mode of BI Engine acceleration was performed (if any).
Enum type. Can be one of the following:
BI_ENGINE_ACCELERATION_MODE_UNSPECIFIED	BiEngineMode type not specified.
BI_ENGINE_DISABLED	BI Engine acceleration was attempted but disabled. bi_engine_reasons specifies a more detailed reason.
PARTIAL_INPUT	Some inputs were accelerated using BI Engine. See bi_engine_reasons for why parts of the query were not accelerated.
FULL_INPUT	All of the query inputs were accelerated using BI Engine.
FULL_QUERY	All of the query was accelerated using BI Engine.
biEngineMode	enum Output only. Specifies which mode of BI Engine acceleration was performed (if any).
Enum type. Can be one of the following:
ACCELERATION_MODE_UNSPECIFIED	BiEngineMode type not specified.
DISABLED	BI Engine disabled the acceleration. bi_engine_reasons specifies a more detailed reason.
PARTIAL	Part of the query was accelerated using BI Engine. See bi_engine_reasons for why parts of the query were not accelerated.
FULL	All of the query was accelerated using BI Engine.
biEngineReasons[]	object (BiEngineReason) In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.

BigLakeConfiguration

Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.)

Fields
connectionId	string Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form {project}.{location}.{connection_id} or `projects/{project}/locations/{location}/connections/{connection_id}".
fileFormat	enum Optional. The file format the table data is stored in.
Enum type. Can be one of the following:
FILE_FORMAT_UNSPECIFIED	Default Value.
PARQUET	Apache Parquet format.
storageUri	string Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format gs://bucket/path_to_table/
tableFormat	enum Optional. The table format the metadata only snapshots are stored in.
Enum type. Can be one of the following:
TABLE_FORMAT_UNSPECIFIED	Default Value.
ICEBERG	Apache Iceberg format.

BigQueryModelTraining

(No description provided)

Fields
currentIteration	integer (int32 format) Deprecated.
expectedTotalIterations	string (int64 format) Deprecated.

BigtableColumn

Information related to a Bigtable column.

Fields
encoding	string Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. PROTO_BINARY - indicates values are encoded using serialized proto messages. This can only be used in combination with JSON type. '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	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	boolean 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.
protoConfig	object (BigtableProtoConfig) Optional. Protobuf-specific configurations, only takes effect when the encoding is PROTO_BINARY.
qualifierEncoded	string (bytes format) [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	string Qualifier string.
type	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.

BigtableColumnFamily

Information related to a Bigtable column family.

Fields
columns[]	object (BigtableColumn) 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 the .Column field.
encoding	string Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. PROTO_BINARY - indicates values are encoded using serialized proto messages. This can only be used in combination with JSON type. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
familyId	string Identifier of the column family.
onlyReadLatest	boolean Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
protoConfig	object (BigtableProtoConfig) Optional. Protobuf-specific configurations, only takes effect when the encoding is PROTO_BINARY.
type	string Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * 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.

BigtableOptions

Options specific to Google Cloud Bigtable data sources.

Fields
columnFamilies[]	object (BigtableColumnFamily) 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.
ignoreUnspecifiedColumnFamilies	boolean Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
outputColumnFamiliesAsJson	boolean 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	boolean Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

BigtableProtoConfig

Information related to a Bigtable protobuf column.

Fields
protoMessageName	string Optional. The fully qualified proto message name of the protobuf. In the format of "foo.bar.Message".
schemaBundleId	string Optional. The ID of the Bigtable SchemaBundle resource associated with this protobuf. The ID should be referred to within the parent table, e.g., foo rather than projects/{project}/instances/{instance}/tables/{table}/schemaBundles/foo. See more details on Bigtable SchemaBundles.

BinaryClassificationMetrics

Evaluation metrics for binary classification/classifier models.

Fields
aggregateClassificationMetrics	object (AggregateClassificationMetrics) Aggregate classification metrics.
binaryConfusionMatrixList[]	object (BinaryConfusionMatrix) Binary confusion matrix at multiple thresholds.
negativeLabel	string Label representing the negative class.
positiveLabel	string Label representing the positive class.

BinaryConfusionMatrix

Confusion matrix for binary classification models.

Fields
accuracy	number (double format) The fraction of predictions given the correct label.
f1Score	number (double format) The equally weighted average of recall and precision.
falseNegatives	string (int64 format) Number of false samples predicted as false.
falsePositives	string (int64 format) Number of false samples predicted as true.
positiveClassThreshold	number (double format) Threshold value used when computing each of the following metric.
precision	number (double format) The fraction of actual positive predictions that had positive actual labels.
recall	number (double format) The fraction of actual positive labels that were given a positive prediction.
trueNegatives	string (int64 format) Number of true samples predicted as false.
truePositives	string (int64 format) Number of true samples predicted as true.

Binding

Associates members, or principals, with a role.

Fields
condition	object (Expr) The condition that is associated with this binding. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.
members[]	string Specifies the principals requesting access for a Google Cloud resource. members can have the following values: * allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. * allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * user:{emailid}: An email address that represents a specific Google account. For example, [e-mail] . * serviceAccount:{emailid}: An email address that represents a Google service account. For example, [e-mail]. * serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account. For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. * group:{emailid}: An email address that represents a Google group. For example, [e-mail]. * domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. * principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. * principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. * principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. * principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. * principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. * principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. * principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. * principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [e-mail]?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. * deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, [e-mail]?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. * deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, [e-mail]?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. * deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
role	string Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. For an overview of the IAM roles and permissions, see the IAM documentation. For a list of the available pre-defined roles, see here.

BqmlIterationResult

(No description provided)

Fields
durationMs	string (int64 format) Deprecated.
evalLoss	number (double format) Deprecated.
index	integer (int32 format) Deprecated.
learnRate	number (double format) Deprecated.
trainingLoss	number (double format) Deprecated.

BqmlTrainingRun

(No description provided)

Fields
iterationResults[]	object (BqmlIterationResult) Deprecated.
startTime	string (date-time format) Deprecated.
state	string Deprecated.
trainingOptions	object Deprecated.
trainingOptions.earlyStop	boolean (No description provided)
trainingOptions.l1Reg	number (double format) (No description provided)
trainingOptions.l2Reg	number (double format) (No description provided)
trainingOptions.learnRate	number (double format) (No description provided)
trainingOptions.learnRateStrategy	string (No description provided)
trainingOptions.lineSearchInitLearnRate	number (double format) (No description provided)
trainingOptions.maxIteration	string (int64 format) (No description provided)
trainingOptions.minRelProgress	number (double format) (No description provided)
trainingOptions.warmStart	boolean (No description provided)

CategoricalValue

Representative value of a categorical feature.

Fields
categoryCounts[]	object (CategoryCount) 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.

CategoryCount

Represents the count of a single category within the cluster.

Fields
category	string The name of category.
count	string (int64 format) The count of training samples matching the category within the cluster.

CloneDefinition

Information about base table and clone time of a table clone.

Fields
baseTableReference	object (TableReference) Required. Reference describing the ID of the table that was cloned.
cloneTime	string (date-time format) Required. The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

Cluster

Message containing the information about one cluster.

Fields
centroidId	string (int64 format) Centroid id.
count	string (int64 format) Count of training data rows that were assigned to this cluster.
featureValues[]	object (FeatureValue) Values of highly variant features for this cluster.

ClusterInfo

Information about a single cluster for clustering model.

Fields
centroidId	string (int64 format) Centroid id.
clusterRadius	number (double format) Cluster radius, the average distance from centroid to each point assigned to the cluster.
clusterSize	string (int64 format) Cluster size, the total number of points assigned to the cluster.

Clustering

Configures table clustering.

Fields
fields[]	string One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see Introduction to clustered tables.

ClusteringMetrics

Evaluation metrics for clustering models.

Fields
clusters[]	object (Cluster) Information for all clusters.
daviesBouldinIndex	number (double format) Davies-Bouldin index.
meanSquaredDistance	number (double format) Mean of squared distances between each sample to its cluster centroid.

ConfusionMatrix

Confusion matrix for multi-class classification models.

Fields
confidenceThreshold	number (double format) Confidence threshold used when computing the entries of the confusion matrix.
rows[]	object (Row) One row per actual label.

ConnectionProperty

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 * service_account: indicates the service account to use to run a continuous query. If set, the query job uses the service account to access Google Cloud resources. Service account access is bounded by the IAM permissions that you have granted to the service account. Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.

Fields
key	string The key of the property to set.
value	string The value of the property to set.

CsvOptions

Information related to a CSV data source.

Fields
allowJaggedRows	boolean Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
allowQuotedNewlines	boolean Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
encoding	string Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
fieldDelimiter	string Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C).
nullMarker	string Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
nullMarkers[]	string Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.
preserveAsciiControlCharacters	boolean Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
quote	string Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ("). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '.
skipLeadingRows	string (int64 format) 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.
sourceColumnMatch	string Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.

DataFormatOptions

Options for data format adjustments.

Fields
timestampOutputFormat	enum Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing use_int64_timestamp option.
Enum type. Can be one of the following:
TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED	Corresponds to default API output behavior, which is FLOAT64.
FLOAT64	Timestamp is output as float64 seconds since Unix epoch.
INT64	Timestamp is output as int64 microseconds since Unix epoch.
ISO8601_STRING	Timestamp is output as ISO 8601 String ("YYYY-MM-DDTHH:MM:SS.FFFFFFFFFFFFZ").
useInt64Timestamp	boolean Optional. Output timestamp as usec int64. Default is false.

DataMaskingStatistics

Statistics for data-masking.

Fields
dataMaskingApplied	boolean Whether any accessed data was protected by the data masking.

DataPolicyList

A list of data policy options. For more information, see Mask data by applying data policies to a column.

Fields
dataPolicies[]	object (DataPolicyOption) Contains a list of data policy options. At most 9 data policies are allowed per field.

DataPolicyOption

Data policy option. For more information, see Mask data by applying data policies to a column.

Fields
name	string Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.

DataSplitResult

Data split result. This contains references to the training and evaluation data tables that were used to train the model.

Fields
evaluationTable	object (TableReference) Table reference of the evaluation data after split.
testTable	object (TableReference) Table reference of the test data after split.
trainingTable	object (TableReference) Table reference of the training data after split.

Dataset

Represents a BigQuery dataset.

Fields
access[]	object Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
access.condition	object (Expr) Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered
access.dataset	object (DatasetAccessEntry) [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
access.domain	string [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
access.groupByEmail	string [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
access.iamMember	string [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
access.role	string An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER: roles/bigquery.dataOwner * WRITER: roles/bigquery.dataEditor * READER: roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
access.routine	object (RoutineReference) [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
access.specialGroup	string [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
access.userByEmail	string [Pick one] An email address of a user to grant access to. For example: [e-mail]. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
access.view	object (TableReference) [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
catalogSource	string Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake
creationTime	string (int64 format) Output only. The time when this dataset was created, in milliseconds since the epoch.
datasetReference	object (DatasetReference) Required. A reference that identifies the dataset.
defaultCollation	string Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
defaultEncryptionConfiguration	object (EncryptionConfiguration) The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key.
defaultPartitionExpirationMs	string (int64 format) This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning.expirationMs property on the new table. If you set TimePartitioning.expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline.
defaultRoundingMode	enum Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified.
Enum type. Can be one of the following:
ROUNDING_MODE_UNSPECIFIED	Unspecified will default to using ROUND_HALF_AWAY_FROM_ZERO.
ROUND_HALF_AWAY_FROM_ZERO	ROUND_HALF_AWAY_FROM_ZERO rounds half values away from zero when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1 1.5, 1.6, 1.7, 1.8, 1.9 => 2
ROUND_HALF_EVEN	ROUND_HALF_EVEN rounds half values to the nearest even value when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1 1.5 => 2 1.6, 1.7, 1.8, 1.9 => 2 2.5 => 2
defaultTableExpirationMs	string (int64 format) Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
description	string Optional. A user-friendly description of the dataset.
etag	string Output only. A hash of the resource.
externalCatalogDatasetOptions	object (ExternalCatalogDatasetOptions) Optional. Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema or namespace represented by the current dataset.
externalDatasetReference	object (ExternalDatasetReference) Optional. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL.
friendlyName	string Optional. A descriptive name for the dataset.
id	string Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
isCaseInsensitive	boolean Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.
kind	string Output only. The resource type.
labels	map (key: string, value: string) The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
lastModifiedTime	string (int64 format) Output only. The date when this dataset was last modified, in milliseconds since the epoch.
linkedDatasetMetadata	object (LinkedDatasetMetadata) Output only. Metadata about the LinkedDataset. Filled out when the dataset type is LINKED.
linkedDatasetSource	object (LinkedDatasetSource) Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored.
location	string The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
maxTimeTravelHours	string (int64 format) Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
resourceTags	map (key: string, value: string) Optional. The tags attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See Tag definitions for more details.
restrictions	object (RestrictionConfig) Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See Data egress for more details.
satisfiesPzi	boolean Output only. Reserved for future use.
satisfiesPzs	boolean Output only. Reserved for future use.
selfLink	string Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
storageBillingModel	enum Optional. Updates storage_billing_model for the dataset.
Enum type. Can be one of the following:
STORAGE_BILLING_MODEL_UNSPECIFIED	Value not set.
LOGICAL	Billing for logical bytes.
PHYSICAL	Billing for physical bytes.
tags[]	object Output only. Tags for the dataset. To provide tags as inputs, use the resourceTags field.
tags.tagKey	string Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
tags.tagValue	string Required. The friendly short name of the tag value, e.g. "production".
type	string Output only. Same as type in ListFormatDataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API.

DatasetAccessEntry

Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset.

Fields
dataset	object (DatasetReference) The dataset this entry applies to
targetTypes[]	string Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future.

DatasetList

Response format for a page of results when listing datasets.

Fields
datasets[]	object An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
datasets.catalogSource	string Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset. * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake.
datasets.datasetReference	object (DatasetReference) The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.
datasets.externalDatasetReference	object (ExternalDatasetReference) Output only. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL.
datasets.friendlyName	string An alternate name for the dataset. The friendly name is purely decorative in nature.
datasets.id	string The fully-qualified, unique, opaque ID of the dataset.
datasets.kind	string The resource type. This property always returns the value "bigquery#dataset"
datasets.labels	map (key: string, value: string) The labels associated with this dataset. You can use these to organize and group your datasets.
datasets.location	string The geographic location where the dataset resides.
datasets.type	string Output only. Same as type in Dataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API.
etag	string Output only. A hash value of the results page. You can use this property to determine if the page has changed since the last request.
kind	string Output only. The resource type. This property always returns the value "bigquery#datasetList"
nextPageToken	string A token that can be used to request the next results page. This property is omitted on the final results page.
unreachable[]	string 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"

DatasetReference

Identifier for a dataset.

Fields
datasetId	string Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
projectId	string Optional. The ID of the project containing this dataset.

DestinationTableProperties

Properties for the destination table.

Fields
description	string Optional. The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
expirationTime	string (date-time format) Internal use only.
friendlyName	string Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.
labels	map (key: string, value: string) 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.

DifferentialPrivacyPolicy

Represents privacy policy associated with "differential privacy" method.

Fields
deltaBudget	number (double format) Optional. The total delta budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of delta that is pre-defined by the contributor through the privacy policy delta_per_query field. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.
deltaBudgetRemaining	number (double format) Output only. The delta budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.
deltaPerQuery	number (double format) Optional. The delta value that is used per query. Delta represents the probability that any row will fail to be epsilon differentially private. Indicates the risk associated with exposing aggregate rows in the result of a query.
epsilonBudget	number (double format) Optional. The total epsilon budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of epsilon they request in their query. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.
epsilonBudgetRemaining	number (double format) Output only. The epsilon budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.
maxEpsilonPerQuery	number (double format) Optional. The maximum epsilon value that a query can consume. If the subscriber specifies epsilon as a parameter in a SELECT query, it must be less than or equal to this value. The epsilon parameter controls the amount of noise that is added to the groups — a higher epsilon means less noise.
maxGroupsContributed	string (int64 format) Optional. The maximum groups contributed value that is used per query. Represents the maximum number of groups to which each protected entity can contribute. Changing this value does not improve or worsen privacy. The best value for accuracy and utility depends on the query and data.
privacyUnitColumn	string Optional. The privacy unit column associated with this policy. Differential privacy policies can only have one privacy unit column per data source object (table, view).

DimensionalityReductionMetrics

Model evaluation metrics for dimensionality reduction models.

Fields
totalExplainedVarianceRatio	number (double format) Total percentage of variance explained by the selected principal components.

DmlStatistics

Detailed statistics for DML statements

Fields
deletedRowCount	string (int64 format) Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
dmlMode	enum Output only. DML mode used.
Enum type. Can be one of the following:
DML_MODE_UNSPECIFIED	Default value. This value is unused.
COARSE_GRAINED_DML	Coarse-grained DML was used.
FINE_GRAINED_DML	Fine-grained DML was used.
fineGrainedDmlUnusedReason	enum Output only. Reason for disabling fine-grained DML if applicable.
Enum type. Can be one of the following:
FINE_GRAINED_DML_UNUSED_REASON_UNSPECIFIED	Default value. This value is unused.
MAX_PARTITION_SIZE_EXCEEDED	Max partition size threshold exceeded. Fine-grained DML Limitations
TABLE_NOT_ENROLLED	The table is not enrolled for fine-grained DML.
DML_IN_MULTI_STATEMENT_TRANSACTION	The DML statement is part of a multi-statement transaction.
insertedRowCount	string (int64 format) Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements
updatedRowCount	string (int64 format) Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.

DoubleCandidates

Discrete candidates of a double hyperparameter.

Fields
candidates[]	number (double format) Candidates for the double parameter in increasing order.

DoubleHparamSearchSpace

Search space for a double hyperparameter.

Fields
candidates	object (DoubleCandidates) Candidates of the double hyperparameter.
range	object (DoubleRange) Range of the double hyperparameter.

DoubleRange

Range of a double hyperparameter.

Fields
max	number (double format) Max value of the double parameter.
min	number (double format) Min value of the double parameter.

EncryptionConfiguration

Configuration for Cloud KMS encryption settings.

Fields
kmsKeyName	string Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

Entry

A single entry in the confusion matrix.

Fields
itemCount	string (int64 format) Number of items being predicted as this label.
predictedLabel	string The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.

ErrorProto

Error details.

Fields
debugInfo	string Debugging information. This property is internal to Google and should not be used.
location	string Specifies where the error occurred, if present.
message	string A human-readable description of the error.
reason	string A short error code that summarizes the error.

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.

Fields
arimaForecastingMetrics	object (ArimaForecastingMetrics) Populated for ARIMA models.
binaryClassificationMetrics	object (BinaryClassificationMetrics) Populated for binary classification/classifier models.
clusteringMetrics	object (ClusteringMetrics) Populated for clustering models.
dimensionalityReductionMetrics	object (DimensionalityReductionMetrics) Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA.
multiClassClassificationMetrics	object (MultiClassClassificationMetrics) Populated for multi-class classification/classifier models.
rankingMetrics	object (RankingMetrics) Populated for implicit feedback type matrix factorization models.
regressionMetrics	object (RegressionMetrics) Populated for regression models and explicit feedback type matrix factorization models.

ExplainQueryStage

A single stage of query execution.

Fields
completedParallelInputs	string (int64 format) Number of parallel input segments completed.
computeMode	enum Output only. Compute mode for this stage.
Enum type. Can be one of the following:
COMPUTE_MODE_UNSPECIFIED	ComputeMode type not specified.
BIGQUERY	This stage was processed using BigQuery slots.
BI_ENGINE	This stage was processed using BI Engine compute.
computeMsAvg	string (int64 format) Milliseconds the average shard spent on CPU-bound tasks.
computeMsMax	string (int64 format) Milliseconds the slowest shard spent on CPU-bound tasks.
computeRatioAvg	number (double format) Relative amount of time the average shard spent on CPU-bound tasks.
computeRatioMax	number (double format) Relative amount of time the slowest shard spent on CPU-bound tasks.
endMs	string (int64 format) Stage end time represented as milliseconds since the epoch.
id	string (int64 format) Unique ID for the stage within the plan.
inputStages[]	string (int64 format) IDs for stages that are inputs to this stage.
name	string Human-readable name for the stage.
parallelInputs	string (int64 format) Number of parallel input segments to be processed
readMsAvg	string (int64 format) Milliseconds the average shard spent reading input.
readMsMax	string (int64 format) Milliseconds the slowest shard spent reading input.
readRatioAvg	number (double format) Relative amount of time the average shard spent reading input.
readRatioMax	number (double format) Relative amount of time the slowest shard spent reading input.
recordsRead	string (int64 format) Number of records read into the stage.
recordsWritten	string (int64 format) Number of records written by the stage.
shuffleOutputBytes	string (int64 format) Total number of bytes written to shuffle.
shuffleOutputBytesSpilled	string (int64 format) Total number of bytes written to shuffle and spilled to disk.
slotMs	string (int64 format) Slot-milliseconds used by the stage.
startMs	string (int64 format) Stage start time represented as milliseconds since the epoch.
status	string Current status for this stage.
steps[]	object (ExplainQueryStep) List of operations within the stage in dependency order (approximately chronological).
waitMsAvg	string (int64 format) Milliseconds the average shard spent waiting to be scheduled.
waitMsMax	string (int64 format) Milliseconds the slowest shard spent waiting to be scheduled.
waitRatioAvg	number (double format) Relative amount of time the average shard spent waiting to be scheduled.
waitRatioMax	number (double format) Relative amount of time the slowest shard spent waiting to be scheduled.
writeMsAvg	string (int64 format) Milliseconds the average shard spent on writing output.
writeMsMax	string (int64 format) Milliseconds the slowest shard spent on writing output.
writeRatioAvg	number (double format) Relative amount of time the average shard spent on writing output.
writeRatioMax	number (double format) Relative amount of time the slowest shard spent on writing output.

ExplainQueryStep

An operation within a stage.

Fields
kind	string Machine-readable operation type.
substeps[]	string Human-readable description of the step(s).

Explanation

Explanation for a single feature.

Fields
attribution	number (double format) Attribution of feature.
featureName	string The full feature name. For non-numerical features, will be formatted like .. Overall size of feature name will always be truncated to first 120 characters.

ExportDataStatistics

Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4.

Fields
fileCount	string (int64 format) Number of destination files generated in case of EXPORT DATA statement only.
rowCount	string (int64 format) [Alpha] Number of destination rows generated in case of EXPORT DATA statement only.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Fields
description	string Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
expression	string Textual representation of an expression in Common Expression Language syntax.
location	string Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title	string Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

ExternalCatalogDatasetOptions

Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema, or namespace represented by the current dataset.

Fields
defaultStorageLocationUri	string Optional. The storage location URI for all tables in the dataset. Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters.
parameters	map (key: string, value: string) Optional. A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2MiB.

ExternalCatalogTableOptions

Metadata about open source compatible table. The fields contained in these options correspond to Hive metastore's table-level properties.

Fields
connectionId	string Optional. A connection ID that specifies the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or Amazon S3. This connection is needed to read the open source table from BigQuery. The connection_id format must be either .. or projects//locations//connections/.
parameters	map (key: string, value: string) Optional. A map of the key-value pairs defining the parameters and properties of the open source table. Corresponds with Hive metastore table parameters. Maximum size of 4MiB.
storageDescriptor	object (StorageDescriptor) Optional. A storage descriptor containing information about the physical storage of this table.

ExternalDataConfiguration

(No description provided)

Fields
autodetect	boolean Try to detect schema and format options automatically. Any option specified explicitly will be honored.
avroOptions	object (AvroOptions) Optional. Additional properties to set if sourceFormat is set to AVRO.
bigtableOptions	object (BigtableOptions) Optional. Additional options if sourceFormat is set to BIGTABLE.
compression	string Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.
connectionId	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	object (CsvOptions) Optional. Additional properties to set if sourceFormat is set to CSV.
dateFormat	string Optional. Format used to parse DATE values. Supports C-style and SQL-style values.
datetimeFormat	string Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values.
decimalTargetTypes[]	string Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
fileSetSpecType	enum 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.
Enum type. Can be one of the following:
FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH	This option expands source URIs by listing files from the object store. It is the default behavior if FileSetSpecType is not set.
FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST	This option indicates that the provided URIs are newline-delimited manifest files, with one URI per line. Wildcard URIs are not supported.
googleSheetsOptions	object (GoogleSheetsOptions) Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
hivePartitioningOptions	object (HivePartitioningOptions) 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.
ignoreUnknownValues	boolean Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.
jsonExtension	enum 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).
Enum type. Can be one of the following:
JSON_EXTENSION_UNSPECIFIED	The default if provided value is not one included in the enum, or the value is not specified. The source format is parsed without any modification.
GEOJSON	Use GeoJSON variant of JSON. See https://tools.ietf.org/html/rfc7946.
jsonOptions	object (JsonOptions) Optional. Additional properties to set if sourceFormat is set to JSON.
maxBadRecords	integer (int32 format) 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	enum Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
Enum type. Can be one of the following:
METADATA_CACHE_MODE_UNSPECIFIED	Unspecified metadata cache mode.
AUTOMATIC	Set this mode to trigger automatic background refresh of metadata cache from the external source. Queries will use the latest available cache version within the table's maxStaleness interval.
MANUAL	Set this mode to enable triggering manual refresh of the metadata cache from external source. Queries will use the latest manually triggered cache version within the table's maxStaleness interval.
objectMetadata	enum 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.
Enum type. Can be one of the following:
OBJECT_METADATA_UNSPECIFIED	Unspecified by default.
DIRECTORY	A synonym for SIMPLE.
SIMPLE	Directory listing of objects.
parquetOptions	object (ParquetOptions) Optional. Additional properties to set if sourceFormat is set to PARQUET.
referenceFileSchemaUri	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	object (TableSchema) 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.
sourceFormat	string [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
sourceUris[]	string [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.
timeFormat	string Optional. Format used to parse TIME values. Supports C-style and SQL-style values.
timeZone	string Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles).
timestampFormat	string Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.
timestampTargetPrecision[]	integer (int32 format) Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.

ExternalDatasetReference

Configures the access a dataset defined in an external metadata storage.

Fields
connection	string Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
externalSource	string Required. External source that backs this dataset.

ExternalRuntimeOptions

Options for the runtime of the external system.

Fields
containerCpu	number (double format) Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see Configure container limits for Python UDFs
containerMemory	string Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see Configure container limits for Python UDFs
containerRequestConcurrency	string (int64 format) Optional. Maximum number of requests that a Python UDF instance can handle concurrently. If absent or if 0, the default concurrency value is used. For more information, see Configure container limits for Python UDFs.
maxBatchingRows	string (int64 format) Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.
runtimeConnection	string Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}"
runtimeVersion	string Optional. Language runtime version. Example: python-3.11.
volumeMounts[]	object (ExternalVolumeMount) Optional. List of volume mounts for the Python UDF container that executes the managed function.

ExternalServiceCost

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.

Fields
billingMethod	string The billing method used for the external job. This field, set to SERVICES_SKU, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility.
bytesBilled	string (int64 format) External service cost in terms of bigquery bytes billed.
bytesProcessed	string (int64 format) External service cost in terms of bigquery bytes processed.
externalService	string External service name.
reservedSlotCount	string (int64 format) Non-preemptable reserved slots used for external job. For example, reserved slots for Cloua AI Platform job are the VM usages converted to BigQuery slot with equivalent mount of price.
slotMs	string (int64 format) External service cost in terms of bigquery slot milliseconds.

ExternalVolumeMount

Configuration of a volume mount for the Python UDF container that executes the managed function.

Fields
mountPath	string Optional. The absolute path within the container where the volume should be mounted.
sourcePath	string Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder.

FeatureValue

Representative value of a single feature within the cluster.

Fields
categoricalValue	object (CategoricalValue) The categorical feature value.
featureColumn	string The feature column name.
numericalValue	number (double format) The numerical feature value. This is the centroid value for this feature.

ForeignTypeInfo

Metadata about the foreign data type definition such as the system in which the type is defined.

Fields
typeSystem	enum Required. Specifies the system which defines the foreign data type.
Enum type. Can be one of the following:
TYPE_SYSTEM_UNSPECIFIED	TypeSystem not specified.
HIVE	Represents Hive data types.

ForeignViewDefinition

A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations.

Fields
dialect	string Optional. Represents the dialect of the query.
query	string Required. The query that defines the view.

GenAiErrorStats

Provides error statistics for the query job across all AI function calls.

Fields
errors[]	string A list of unique errors at query level (up to 5, truncated to 100 chars)

GenAiFunctionCacheStats

Provides cache statistics for a GenAi function call.

Fields
numCacheHitRows	string (int64 format) Number of rows served from cache.

GenAiFunctionCostOptimizationStats

Provides cost optimization statistics for a GenAi function call.

Fields
message	string System generated message to provide insights into cost optimization state.
numCostOptimizedRows	string (int64 format) Number of rows inferred via cost optimized workflow.

GenAiFunctionErrorStats

Provides error statistics for a GenAi function call.

Fields
errors[]	string A list of unique errors at function level (up to 5, truncated to 100 chars).
numFailedRows	string (int64 format) Number of failed rows processed by the function

GenAiFunctionStats

Provides statistics for each Ai function call within a query.

Fields
cacheStats	object (GenAiFunctionCacheStats) Cache stats for the function.
costOptimizationStats	object (GenAiFunctionCostOptimizationStats) Cost optimization stats if applied on the rows processed by the function.
errorStats	object (GenAiFunctionErrorStats) Error stats for the function.
functionName	string Name of the function.
numProcessedRows	string (int64 format) Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows.
prompt	string User input prompt of the function (truncated to 20 chars).

GenAiStats

GenAi stats for the query job.

Fields
errorStats	object (GenAiErrorStats) Job level error stats across all GenAi functions
functionStats[]	object (GenAiFunctionStats) Function level stats for GenAI Functions. For more information, see Generative AI overview.

GeneratedColumn

Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields).

Fields
generatedExpressionInfo	object (GeneratedExpressionInfo) Definition of the expression used to generate the field.
generatedMode	enum Optional. Dictates when system generated values are used to populate the field.
Enum type. Can be one of the following:
GENERATED_MODE_UNSPECIFIED	Unspecified GeneratedMode will default to GENERATED_ALWAYS.
GENERATED_ALWAYS	Field can only have system generated values. Users cannot manually insert values into the field.
GENERATED_BY_DEFAULT	Use system generated values only if the user does not explicitly provide a value.

GeneratedExpressionInfo

Definition of the expression used to generate the field.

Fields
asynchronous	boolean Optional. Whether the column generation is done asynchronously.
generationExpression	string Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field.
stored	boolean Optional. Whether the generated column is stored in the table.

GetIamPolicyRequest

Request message for GetIamPolicy method.

Fields
options	object (GetPolicyOptions) OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

Fields

requestedPolicyVersion

integer (int32 format) Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

GetQueryResultsResponse

Response object of GetQueryResults.

Fields
cacheHit	boolean Whether the query result was fetched from the query cache.
errors[]	object (ErrorProto) 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.
etag	string A hash of this response.
jobComplete	boolean 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	object (JobReference) 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).
kind	string The resource type of the response.
numDmlAffectedRows	string (int64 format) Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
pageToken	string A token used for paging results. When this token is non-empty, it indicates additional results are available.
rows[]	object (TableRow) 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.
schema	object (TableSchema) The schema of the results. Present only when the query completes successfully.
totalBytesProcessed	string (int64 format) The total number of bytes processed for this query.
totalRows	string (uint64 format) 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.

GetServiceAccountResponse

Response object of GetServiceAccount

Fields
email	string The service account email address.
kind	string The resource type of the response.

GlobalExplanation

Global explanations containing the top most important features after training.

Fields
classLabel	string Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.
explanations[]	object (Explanation) A list of the top global explanations. Sorted by absolute value of attribution in descending order.

GoogleSheetsOptions

Options specific to Google Sheets data sources.

Fields
range	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	string (int64 format) 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.

HighCardinalityJoin

High cardinality join detailed information.

Fields
leftRows	string (int64 format) Output only. Count of left input rows.
outputRows	string (int64 format) Output only. Count of the output rows.
rightRows	string (int64 format) Output only. Count of right input rows.
stepIndex	integer (int32 format) Output only. The index of the join operator in the ExplainQueryStep lists.

HivePartitioningOptions

Options for configuring hive partitioning detect.

Fields
fields[]	string Output only. For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
mode	string Optional. When set, what mode of hive partitioning to use when reading data. The following modes are supported: * AUTO: automatically infer partition key name(s) and type(s). * STRINGS: automatically infer partition key name(s). All types are strings. * CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported formats are: JSON, CSV, ORC, Avro and Parquet.
requirePartitionFilter	boolean Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.
sourceUriPrefix	string Optional. When hive partition detection is requested, a common prefix for all source uris must be required. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout: gs://bucket/path_to_table/dt=2019-06-01/country=USA/id=7/file.avro gs://bucket/path_to_table/dt=2019-05-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/. CUSTOM detection requires encoding the partitioning schema immediately after the common prefix. For CUSTOM, any of * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:STRING}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:STRING} would all be valid source URI prefixes.

HparamSearchSpaces

Hyperparameter search spaces. These should be a subset of training_options.

Fields
activationFn	object (StringHparamSearchSpace) Activation functions of neural network models.
batchSize	object (IntHparamSearchSpace) Mini batch sample size.
boosterType	object (StringHparamSearchSpace) Booster type for boosted tree models.
colsampleBylevel	object (DoubleHparamSearchSpace) Subsample ratio of columns for each level for boosted tree models.
colsampleBynode	object (DoubleHparamSearchSpace) Subsample ratio of columns for each node(split) for boosted tree models.
colsampleBytree	object (DoubleHparamSearchSpace) Subsample ratio of columns when constructing each tree for boosted tree models.
dartNormalizeType	object (StringHparamSearchSpace) Dart normalization type for boosted tree models.
dropout	object (DoubleHparamSearchSpace) Dropout probability for dnn model training and boosted tree models using dart booster.
hiddenUnits	object (IntArrayHparamSearchSpace) Hidden units for neural network models.
l1Reg	object (DoubleHparamSearchSpace) L1 regularization coefficient.
l2Reg	object (DoubleHparamSearchSpace) L2 regularization coefficient.
learnRate	object (DoubleHparamSearchSpace) Learning rate of training jobs.
maxTreeDepth	object (IntHparamSearchSpace) Maximum depth of a tree for boosted tree models.
minSplitLoss	object (DoubleHparamSearchSpace) Minimum split loss for boosted tree models.
minTreeChildWeight	object (IntHparamSearchSpace) Minimum sum of instance weight needed in a child for boosted tree models.
numClusters	object (IntHparamSearchSpace) Number of clusters for k-means.
numFactors	object (IntHparamSearchSpace) Number of latent factors to train on.
numParallelTree	object (IntHparamSearchSpace) Number of parallel trees for boosted tree models.
optimizer	object (StringHparamSearchSpace) Optimizer of TF models.
subsample	object (DoubleHparamSearchSpace) Subsample the training data to grow tree to prevent overfitting for boosted tree models.
treeMethod	object (StringHparamSearchSpace) Tree construction algorithm for boosted tree models.
walsAlpha	object (DoubleHparamSearchSpace) Hyperparameter for matrix factoration when implicit feedback type is specified.

HparamTuningTrial

Training info of a trial in hyperparameter tuning models.

Fields
endTimeMs	string (int64 format) Ending time of the trial.
errorMessage	string Error message for FAILED and INFEASIBLE trial.
evalLoss	number (double format) Loss computed on the eval data at the end of trial.
evaluationMetrics	object (EvaluationMetrics) Evaluation metrics of this trial calculated on the test data. Empty in Job API.
hparamTuningEvaluationMetrics	object (EvaluationMetrics) 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.
hparams	object (TrainingOptions) The hyperprameters selected for this trial.
startTimeMs	string (int64 format) Starting time of the trial.
status	enum The status of the trial.
Enum type. Can be one of the following:
TRIAL_STATUS_UNSPECIFIED	Default value.
NOT_STARTED	Scheduled but not started.
RUNNING	Running state.
SUCCEEDED	The trial succeeded.
FAILED	The trial failed.
INFEASIBLE	The trial is infeasible due to the invalid params.
STOPPED_EARLY	Trial stopped early because it's not promising.
trainingLoss	number (double format) Loss computed on the training data at the end of trial.
trialId	string (int64 format) 1-based index of the trial.

IncrementalResultStats

Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available.

Fields
disabledReason	enum Output only. Reason why incremental query results are/were not written by the query.
Enum type. Can be one of the following:
DISABLED_REASON_UNSPECIFIED	Disabled reason not specified.
OTHER	Incremental results are/were disabled for reasons not covered by the other enum values, e.g. runtime issues.
UNSUPPORTED_OPERATOR	Query includes an operation that is not supported.
disabledReasonDetails	string Output only. Additional human-readable clarification, if available, for DisabledReason.
firstIncrementalRowTime	string (Timestamp format) Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.
incrementalRowCount	string (int64 format) Output only. Number of rows that were in the latest result set before query completion.
lastIncrementalRowTime	string (Timestamp format) Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.
resultSetLastModifyTime	string (Timestamp format) Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.
resultSetLastReplaceTime	string (Timestamp format) Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.

IndexPruningStats

Statistics for index pruning.

Fields
baseTable	object (TableReference) The base table reference.
indexId	string The index id.
postIndexPruningParallelInputCount	string (int64 format) The number of parallel inputs after index pruning.
preIndexPruningParallelInputCount	string (int64 format) The number of parallel inputs before index pruning.

IndexUnusedReason

Reason about why no search index was used in the search query (or sub-query).

Fields
baseTable	object (TableReference) Specifies the base table involved in the reason that no search index was used.
code	enum Specifies the high-level reason for the scenario when no search index was used.
Enum type. Can be one of the following:
CODE_UNSPECIFIED	Code not specified.
INDEX_CONFIG_NOT_AVAILABLE	Indicates the search index configuration has not been created.
PENDING_INDEX_CREATION	Indicates the search index creation has not been completed.
BASE_TABLE_TRUNCATED	Indicates the base table has been truncated (rows have been removed from table with TRUNCATE TABLE statement) since the last time the search index was refreshed.
INDEX_CONFIG_MODIFIED	Indicates the search index configuration has been changed since the last time the search index was refreshed.
TIME_TRAVEL_QUERY	Indicates the search query accesses data at a timestamp before the last time the search index was refreshed.
NO_PRUNING_POWER	Indicates the usage of search index will not contribute to any pruning improvement for the search function, e.g. when the search predicate is in a disjunction with other non-search predicates.
UNINDEXED_SEARCH_FIELDS	Indicates the search index does not cover all fields in the search function.
UNSUPPORTED_SEARCH_PATTERN	Indicates the search index does not support the given search query pattern.
OPTIMIZED_WITH_MATERIALIZED_VIEW	Indicates the query has been optimized by using a materialized view.
SECURED_BY_DATA_MASKING	Indicates the query has been secured by data masking, and thus search indexes are not applicable.
MISMATCHED_TEXT_ANALYZER	Indicates that the search index and the search function call do not have the same text analyzer.
BASE_TABLE_TOO_SMALL	Indicates the base table is too small (below a certain threshold). The index does not provide noticeable search performance gains when the base table is too small.
BASE_TABLE_TOO_LARGE	Indicates that the total size of indexed base tables in your organization exceeds your region's limit and the index is not used in the query. To index larger base tables, you can use your own reservation for index-management jobs.
ESTIMATED_PERFORMANCE_GAIN_TOO_LOW	Indicates that the estimated performance gain from using the search index is too low for the given search query.
COLUMN_METADATA_INDEX_NOT_USED	Indicates that the column metadata index (which the search index depends on) is not used. User can refer to the column metadata index usage for more details on why it was not used.
NOT_SUPPORTED_IN_STANDARD_EDITION	Indicates that search indexes can not be used for search query with STANDARD edition.
INDEX_SUPPRESSED_BY_FUNCTION_OPTION	Indicates that an option in the search function that cannot make use of the index has been selected.
QUERY_CACHE_HIT	Indicates that the query was cached, and thus the search index was not used.
STALE_INDEX	The index cannot be used in the search query because it is stale.
INTERNAL_ERROR	Indicates an internal error that causes the search index to be unused.
OTHER_REASON	Indicates that the reason search indexes cannot be used in the query is not covered by any of the other IndexUnusedReason options.
indexName	string Specifies the name of the unused search index, if available.
message	string Free form human-readable reason for the scenario when no search index was used.

InputDataChange

Details about the input data change insight.

Fields
recordsReadDiffPercentage	number (float format) Output only. Records read difference percentage compared to a previous run.

IntArray

An array of int.

Fields
elements[]	string (int64 format) Elements in the int array.

IntArrayHparamSearchSpace

Search space for int array.

Fields
candidates[]	object (IntArray) Candidates for the int array parameter.

IntCandidates

Discrete candidates of an int hyperparameter.

Fields
candidates[]	string (int64 format) Candidates for the int parameter in increasing order.

IntHparamSearchSpace

Search space for an int hyperparameter.

Fields
candidates	object (IntCandidates) Candidates of the int hyperparameter.
range	object (IntRange) Range of the int hyperparameter.

IntRange

Range of an int hyperparameter.

Fields
max	string (int64 format) Max value of the int parameter.
min	string (int64 format) Min value of the int parameter.

IterationResult

Information about a single iteration of the training run.

Fields
arimaResult	object (ArimaResult) Arima result.
clusterInfos[]	object (ClusterInfo) Information about top clusters for clustering models.
durationMs	string (int64 format) Time taken to run the iteration in milliseconds.
evalLoss	number (double format) Loss computed on the eval data at the end of iteration.
index	integer (int32 format) Index of the iteration, 0 based.
learnRate	number (double format) Learn rate used for this iteration.
principalComponentInfos[]	object (PrincipalComponentInfo) The information of the principal components.
trainingLoss	number (double format) Loss computed on the training data at the end of iteration.

Job

(No description provided)

Fields
configuration	object (JobConfiguration) Required. Describes the job configuration.
configuration.load.rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
configuration.load.rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
configuration.load.rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
etag	string Output only. A hash of this resource.
id	string Output only. Opaque ID field of the job.
jobCreationReason	object (JobCreationReason) Output only. The reason why a Job was created.
jobReference	object (JobReference) Optional. Reference describing the unique-per-user name of the job.
kind	string Output only. The type of the resource.
principal_subject	string Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities.
selfLink	string Output only. A URL that can be used to access the resource again.
statistics	object (JobStatistics) Output only. Information about the job, including starting time and ending time of the job.
statistics.query.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
statistics.query.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
statistics.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
statistics.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
status	object (JobStatus) Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
user_email	string Output only. Email address of the user who ran the job.

JobCancelResponse

Describes format of a jobs cancellation response.

Fields
job	object (Job) The final state of the job.
job.configuration.load.rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
job.configuration.load.rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
job.configuration.load.rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
job.statistics.query.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
job.statistics.query.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
job.statistics.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
job.statistics.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
kind	string The resource type of the response.

JobConfiguration

(No description provided)

Fields
copy	object (JobConfigurationTableCopy) [Pick one] Copies a table.
dryRun	boolean Optional. If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
extract	object (JobConfigurationExtract) [Pick one] Configures an extract job.
jobTimeoutMs	string (int64 format) Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.
jobType	string Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
labels	map (key: string, value: string) The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
load	object (JobConfigurationLoad) [Pick one] Configures a load job.
load.rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
load.rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
load.rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
maxSlots	integer (int32 format) Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.
query	object (JobConfigurationQuery) [Pick one] Configures a query job.
reservation	string Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is projects/{project}/locations/{location}/reservations/{reservation}. Forces the query to use on-demand billing when set to none, which requires the project or organization to have reservation_override_mode set to ALLOW_ANY_OVERRIDE.

JobConfigurationExtract

JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.

Fields
compression	string Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models.
destinationFormat	string Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
destinationUri	string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
destinationUris[]	string [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
fieldDelimiter	string Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
modelExtractOptions	object (ModelExtractOptions) Optional. Model extract options only applicable when extracting models.
nativeGeographyExportEnabled	boolean Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type.
printHeader	boolean Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
sourceModel	object (ModelReference) A reference to the model being exported.
sourceTable	object (TableReference) A reference to the table being exported.
useAvroLogicalTypes	boolean Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.

JobConfigurationLoad

JobConfigurationLoad contains the configuration properties for loading data into a destination table.

Fields
allowJaggedRows	boolean Optional. Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
allowQuotedNewlines	boolean Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
autodetect	boolean Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.
clustering	object (Clustering) Clustering specification for the destination table.
columnNameCharacterMap	enum Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error.
Enum type. Can be one of the following:
COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED	Unspecified column name character map.
STRICT	Support flexible column name and reject invalid column names.
V1	Support alphanumeric + underscore characters and names must start with a letter or underscore. Invalid column names will be normalized.
V2	Support flexible column name. Invalid column names will be normalized.
connectionProperties[]	object (ConnectionProperty) Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id.
copyFilesOnly	boolean Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * source_uris are located in the same Cloud Storage location as the destination table's storage_uri location. * source_format is PARQUET. * destination_table is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified.
createDisposition	string Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession	boolean Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a ConnectionProperty value. The session identifier is returned as part of the SessionInfo message within the query statistics. The new session's location will be set to Job.JobReference.location if it is present, otherwise it's set to the default location based on existing routing logic.
dateFormat	string Optional. Date format used for parsing DATE values.
datetimeFormat	string Optional. Date format used for parsing DATETIME values.
decimalTargetTypes[]	string Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
destinationEncryptionConfiguration	object (EncryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys)
destinationTable	object (TableReference) [Required] The destination table to load the data into.
destinationTableProperties	object (DestinationTableProperties) Optional. [Experimental] Properties with which to create the destination table if it is new.
encoding	string Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. If you don't specify an encoding, or if you specify a UTF-8 encoding when the CSV file is not UTF-8 encoded, BigQuery attempts to convert the data to UTF-8. Generally, your data loads successfully, but it may not match byte-for-byte what you expect. To avoid this, specify the correct encoding by using the --encoding flag. If BigQuery can't convert a character other than the ASCII 0 character, BigQuery converts the character to the standard Unicode replacement character: �.
fieldDelimiter	string Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C).
fileSetSpecType	enum 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.
Enum type. Can be one of the following:
FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH	This option expands source URIs by listing files from the object store. It is the default behavior if FileSetSpecType is not set.
FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST	This option indicates that the provided URIs are newline-delimited manifest files, with one URI per line. Wildcard URIs are not supported.
hivePartitioningOptions	object (HivePartitioningOptions) 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.
ignoreUnknownValues	boolean Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.
jsonExtension	enum 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).
Enum type. Can be one of the following:
JSON_EXTENSION_UNSPECIFIED	The default if provided value is not one included in the enum, or the value is not specified. The source format is parsed without any modification.
GEOJSON	Use GeoJSON variant of JSON. See https://tools.ietf.org/html/rfc7946.
maxBadRecords	integer (int32 format) Optional. The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This is only supported for CSV and NEWLINE_DELIMITED_JSON file formats.
nullMarker	string Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
nullMarkers[]	string Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.
parquetOptions	object (ParquetOptions) Optional. Additional properties to set if sourceFormat is set to PARQUET.
preserveAsciiControlCharacters	boolean Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
projectionFields[]	string If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
quote	string Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default "
rangePartitioning	object (RangePartitioning) Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
referenceFileSchemaUri	string Optional. The user can provide a reference file with the reader schema. This file is only loaded if it is part of source URIs, but is not loaded otherwise. It is enabled for the following formats: AVRO, PARQUET, ORC.
schema	object (TableSchema) 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.
schemaInline	string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
schemaInlineFormat	string [Deprecated] The format of the schemaInline property.
schemaUpdateOptions[]	string Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
skipLeadingRows	integer (int32 format) Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
sourceColumnMatch	enum Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.
Enum type. Can be one of the following:
SOURCE_COLUMN_MATCH_UNSPECIFIED	Uses sensible defaults based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.
POSITION	Matches by position. This assumes that the columns are ordered the same way as the schema.
NAME	Matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.
sourceFormat	string Optional. The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
sourceUris[]	string [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
timeFormat	string Optional. Date format used for parsing TIME values.
timePartitioning	object (TimePartitioning) Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
timeZone	string Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone.
timestampFormat	string Optional. Date format used for parsing TIMESTAMP values.
timestampTargetPrecision[]	integer (int32 format) Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.
useAvroLogicalTypes	boolean Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
writeDisposition	string Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

JobConfigurationQuery

JobConfigurationQuery configures a BigQuery query job.

Fields
allowLargeResults	boolean Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
clustering	object (Clustering) Clustering specification for the destination table.
connectionProperties[]	object (ConnectionProperty) Connection properties which can modify the query behavior.
continuous	boolean [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
createDisposition	string Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession	boolean If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a ConnectionProperty value. The session identifier is returned as part of the SessionInfo message within the query statistics. The new session's location will be set to Job.JobReference.location if it is present, otherwise it's set to the default location based on existing routing logic.
defaultDataset	object (DatasetReference) 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.
destinationEncryptionConfiguration	object (EncryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys)
destinationTable	object (TableReference) 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.
flattenResults	boolean Optional. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For GoogleSQL queries, this flag is ignored and results are never flattened.
maximumBillingTier	integer (int32 format) Optional. [Deprecated] Maximum billing tier allowed for this query. The billing tier controls the amount of compute resources allotted to the query, and multiplies the on-demand cost of the query accordingly. A query that runs within its allotted resources will succeed and indicate its billing tier in statistics.query.billingTier, but if the query exceeds its allotted resources, it will fail with billingTierLimitExceeded. WARNING: The billed byte amount can be multiplied by an amount up to this number! Most users should not need to alter this setting, and we recommend that you avoid introducing new uses of it.
maximumBytesBilled	string (int64 format) Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
parameterMode	string GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserveNulls	boolean [Deprecated] This property is deprecated.
priority	string Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
query	string [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.
queryParameters[]	object (QueryParameter) Query parameters for GoogleSQL queries.
rangePartitioning	object (RangePartitioning) Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
schemaUpdateOptions[]	string Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
scriptOptions	object (ScriptOptions) Options controlling the execution of scripts.
secureContext	object (SecureContext) Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query.
systemVariables	object (SystemVariables) 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.
tableDefinitions	map (key: string, value: object (ExternalDataConfiguration)) Optional. You can specify external table definitions, which operate as ephemeral tables that can be queried. These definitions are configured using a JSON map, where the string key represents the table identifier, and the value is the corresponding external data configuration object.
timePartitioning	object (TimePartitioning) Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useLegacySql	boolean Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's GoogleSQL. When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
useQueryCache	boolean Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
userDefinedFunctionResources[]	object (UserDefinedFunctionResource) Describes user-defined function resources used in the query.
writeDisposition	string Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
writeIncrementalResults	boolean Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.

JobConfigurationTableCopy

JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see Copy a table.

Fields
createDisposition	string Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
destinationEncryptionConfiguration	object (EncryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys).
destinationExpirationTime	string (Timestamp format) Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
destinationTable	object (TableReference) [Required] The destination table.
operationType	enum Optional. Supported operation types in table copy job.
Enum type. Can be one of the following:
OPERATION_TYPE_UNSPECIFIED	Unspecified operation type.
COPY	The source and destination table have the same table type.
SNAPSHOT	The source table type is TABLE and the destination table type is SNAPSHOT.
RESTORE	The source table type is SNAPSHOT and the destination table type is TABLE.
CLONE	The source and destination table have the same table type, but only bill for unique data.
sourceTable	object (TableReference) [Pick one] Source table to copy.
sourceTables[]	object (TableReference) [Pick one] Source tables to copy.
writeDisposition	string Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema and table constraints from the source table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

JobCreationReason

Reason about why a Job was created from a jobs.query method when used with JOB_CREATION_OPTIONAL Job creation mode. For jobs.insert method calls it will always be REQUESTED.

Fields
code	enum Output only. Specifies the high level reason why a Job was created.
Enum type. Can be one of the following:
CODE_UNSPECIFIED	Reason is not specified.
REQUESTED	Job creation was requested.
LONG_RUNNING	The query request ran beyond a system defined timeout specified by the timeoutMs field in the QueryRequest. As a result it was considered a long running operation for which a job was created.
LARGE_RESULTS	The results from the query cannot fit in the response.
OTHER	BigQuery has determined that the query needs to be executed as a Job.

JobList

JobList is the response format for a jobs.list call.

Fields
etag	string A hash of this page of results.
jobs[]	object List of jobs that were requested.
jobs.configuration	object (JobConfiguration) Required. Describes the job configuration.
jobs.configuration.load.rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
jobs.configuration.load.rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
jobs.configuration.load.rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
jobs.errorResult	object (ErrorProto) A result object that will be present only if the job has failed.
jobs.id	string Unique opaque ID of the job.
jobs.jobReference	object (JobReference) Unique opaque ID of the job.
jobs.kind	string The resource type.
jobs.principal_subject	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.
jobs.state	string Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
jobs.statistics	object (JobStatistics) Output only. Information about the job, including starting time and ending time of the job.
jobs.statistics.query.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
jobs.statistics.query.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
jobs.statistics.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
jobs.statistics.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
jobs.status	object (JobStatus) [Full-projection-only] Describes the status of this job.
jobs.user_email	string [Full-projection-only] Email address of the user who ran the job.
kind	string The resource type of the response.
nextPageToken	string A token to request the next page of results.
unreachable[]	string 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"

JobReference

A job reference is a fully qualified identifier for referring to a job.

Fields
jobId	string Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
location	string Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations
projectId	string Required. The ID of the project containing this job.

JobStatistics

Statistics for a single job execution.

Fields
completionRatio	number (double format) Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
copy	object (JobStatistics5) Output only. Statistics for a copy job.
creationTime	string (int64 format) Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
dataMaskingStatistics	object (DataMaskingStatistics) Output only. Statistics for data-masking. Present only for query and extract jobs.
edition	enum Output only. Name of edition corresponding to the reservation for this job at the time of this update.
Enum type. Can be one of the following:
RESERVATION_EDITION_UNSPECIFIED	Default value, which will be treated as ENTERPRISE.
STANDARD	Standard edition.
ENTERPRISE	Enterprise edition.
ENTERPRISE_PLUS	Enterprise Plus edition.
endTime	string (int64 format) 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	object (JobStatistics4) Output only. Statistics for an extract job.
finalExecutionDurationMs	string (int64 format) Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job.
globalQueryRemoteRegions[]	string Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see Global queries.
load	object (JobStatistics3) Output only. Statistics for a load job.
numChildJobs	string (int64 format) Output only. Number of child jobs executed.
parentGlobalQueryJob	object (JobReference) Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see Global queries.
parentJobId	string Output only. If this is a child job, specifies the job ID of the parent.
query	object (JobStatistics2) Output only. Statistics for a query job.
query.reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
query.reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
quotaDeferments[]	string Output only. Quotas which delayed this job's start time.
reservationGroupPath[]	string Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.
reservationUsage[]	object Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
reservation_id	string Output only. Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
rowLevelSecurityStatistics	object (RowLevelSecurityStatistics) Output only. Statistics for row-level security. Present only for query and extract jobs.
scriptStatistics	object (ScriptStatistics) Output only. If this a child job of a script, specifies information about the context of this job within the script.
sessionInfo	object (SessionInfo) Output only. Information of the session if this job is part of one.
startTime	string (int64 format) Output only. Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
totalBytesProcessed	string (int64 format) Output only. Total bytes processed for the job.
totalSlotMs	string (int64 format) Output only. Slot-milliseconds for the job.
transactionInfo	object (TransactionInfo) 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.

JobStatistics2

Statistics for a query job.

Fields
biEngineStatistics	object (BiEngineStatistics) Output only. BI Engine specific Statistics.
billingTier	integer (int32 format) Output only. Billing tier for the job. This is a BigQuery-specific concept which is not related to the Google Cloud notion of "free tier". The value here is a measure of the query's resource consumption relative to the amount of data scanned. For on-demand queries, the limit is 100, and all queries within this limit are billed at the standard on-demand rates. On-demand queries that exceed this limit will fail with a billingTierLimitExceeded error.
cacheHit	boolean Output only. Whether the query result was fetched from the query cache.
dclTargetDataset	object (DatasetReference) Output only. Referenced dataset for DCL statement.
dclTargetTable	object (TableReference) Output only. Referenced table for DCL statement.
dclTargetView	object (TableReference) Output only. Referenced view for DCL statement.
ddlAffectedRowAccessPolicyCount	string (int64 format) Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
ddlDestinationTable	object (TableReference) Output only. The table after rename. Present only for ALTER TABLE RENAME TO query.
ddlOperationPerformed	string Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
ddlTargetDataset	object (DatasetReference) Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries.
ddlTargetRoutine	object (RoutineReference) Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
ddlTargetRowAccessPolicy	object (RowAccessPolicyReference) Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
ddlTargetTable	object (TableReference) Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
dmlStats	object (DmlStatistics) Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
estimatedBytesProcessed	string (int64 format) Output only. The original estimate of bytes processed for the job.
exportDataStatistics	object (ExportDataStatistics) Output only. Stats for EXPORT DATA statement.
externalServiceCosts[]	object (ExternalServiceCost) Output only. Job cost breakdown as bigquery internal cost and external service costs.
genAiStats	object (GenAiStats) Output only. Statistics related to GenAI usage in the query.
incrementalResultStats	object (IncrementalResultStats) Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
loadQueryStatistics	object (LoadQueryStatistics) Output only. Statistics for a LOAD query.
materializedViewStatistics	object (MaterializedViewStatistics) Output only. Statistics of materialized views of a query job.
metadataCacheStatistics	object (MetadataCacheStatistics) Output only. Statistics of metadata cache usage in a query for BigLake tables.
mlStatistics	object (MlStatistics) Output only. Statistics of a BigQuery ML training job.
modelTraining	object (BigQueryModelTraining) Deprecated.
modelTrainingCurrentIteration	integer (int32 format) Deprecated.
modelTrainingExpectedTotalIteration	string (int64 format) Deprecated.
numDmlAffectedRows	string (int64 format) Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
objectStorageStats[]	object (ObjectStorageStats) Output only. Storage and caching statistics per cloud provider for queries over object storage.
performanceInsights	object (PerformanceInsights) Output only. Performance insights.
queryInfo	object (QueryInfo) Output only. Query optimization information for a QUERY job.
queryPlan[]	object (ExplainQueryStage) Output only. Describes execution plan for the query.
referencedLogicalViews[]	object (TableReference) Output only. Referenced logical views for the job.
referencedPropertyGraphs[]	object (PropertyGraphReference) Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list.
referencedRoutines[]	object (RoutineReference) Output only. Referenced routines for the job.
referencedTables[]	object (TableReference) Output only. Referenced tables for the job.
reservationUsage[]	object Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
reservationUsage.name	string Reservation name or "unreserved" for on-demand resource usage and multi-statement queries.
reservationUsage.slotMs	string (int64 format) Total slot milliseconds used by the reservation for a particular job.
schema	object (TableSchema) Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.
searchStatistics	object (SearchStatistics) Output only. Search query specific statistics.
sparkStatistics	object (SparkStatistics) Output only. Statistics of a Spark procedure job.
statementType	string Output only. The type of query statement, if valid. Possible values: * SELECT: SELECT statement. * ASSERT: ASSERT statement. * INSERT: INSERT statement. * UPDATE: UPDATE statement. * DELETE: DELETE statement. * MERGE: MERGE statement. * TRUNCATE_TABLE: TRUNCATE TABLE statement. * CREATE_TABLE: CREATE TABLE statement, without AS SELECT. * CREATE_TABLE_AS_SELECT: CREATE TABLE AS SELECT statement. * CREATE_VIEW: CREATE VIEW statement. * CREATE_MODEL: CREATE MODEL statement. * CREATE_MATERIALIZED_VIEW: CREATE MATERIALIZED VIEW statement. * CREATE_FUNCTION: CREATE FUNCTION statement. * CREATE_TABLE_FUNCTION: CREATE TABLE FUNCTION statement. * CREATE_PROCEDURE: CREATE PROCEDURE statement. * CREATE_ROW_ACCESS_POLICY: CREATE ROW ACCESS POLICY statement. * CREATE_SCHEMA: CREATE SCHEMA statement. * CREATE_EXTERNAL_SCHEMA: CREATE EXTERNAL SCHEMA statement. * CREATE_EXTERNAL_TABLE: CREATE EXTERNAL TABLE statement. * CREATE_SNAPSHOT_TABLE: CREATE SNAPSHOT TABLE statement. * CREATE_SEARCH_INDEX: CREATE SEARCH INDEX statement. * CREATE_VECTOR_INDEX: CREATE VECTOR INDEX statement. * CREATE_CONNECTION: CREATE CONNECTION statement. * CREATE_DATA_POLICY: CREATE DATA_POLICY statement. * CREATE_PROPERTY_GRAPH: CREATE PROPERTY GRAPH statement. * CREATE_CAPACITY: CREATE CAPACITY statement. * CREATE_RESERVATION: CREATE RESERVATION statement. * CREATE_ASSIGNMENT: CREATE ASSIGNMENT statement. * DROP_TABLE: DROP TABLE statement. * DROP_EXTERNAL_TABLE: DROP EXTERNAL TABLE statement. * DROP_VIEW: DROP VIEW statement. * DROP_MODEL: DROP MODEL statement. * DROP_MATERIALIZED_VIEW: DROP MATERIALIZED VIEW statement. * DROP_FUNCTION: DROP FUNCTION statement. * DROP_TABLE_FUNCTION: DROP TABLE FUNCTION statement. * DROP_PROCEDURE: DROP PROCEDURE statement. * DROP_SEARCH_INDEX: DROP SEARCH INDEX statement. * DROP_VECTOR_INDEX: DROP VECTOR INDEX statement. * DROP_SCHEMA: DROP SCHEMA statement. * UNDROP_SCHEMA: UNDROP SCHEMA statement. * DROP_SNAPSHOT_TABLE: DROP SNAPSHOT TABLE statement. * DROP_ROW_ACCESS_POLICY: DROP [ALL] ROW ACCESS POLICY|POLICIES statement. * DROP_CONNECTION: DROP CONNECTION statement. * DROP_DATA_POLICY: DROP DATA_POLICY statement. * DROP_PROPERTY_GRAPH: DROP PROPERTY GRAPH statement. * DROP_CAPACITY: DROP CAPACITY statement. * DROP_RESERVATION: DROP RESERVATION statement. * DROP_ASSIGNMENT: DROP ASSIGNMENT statement. * ALTER_TABLE: ALTER TABLE statement. * ALTER_VIEW: ALTER VIEW statement. * ALTER_MATERIALIZED_VIEW: ALTER MATERIALIZED VIEW statement. * ALTER_SCHEMA: ALTER SCHEMA statement. * ALTER_MODEL: ALTER MODEL statement. * ALTER_SEARCH_INDEX: ALTER SEARCH INDEX statement. * ALTER_VECTOR_INDEX: ALTER VECTOR INDEX statement. * ALTER_CONNECTION: ALTER CONNECTION statement. * ALTER_DATA_POLICY: ALTER DATA_POLICY statement. * ALTER_PROJECT: ALTER PROJECT statement. * ALTER_ORGANIZATION: ALTER ORGANIZATION statement. * ALTER_BI_CAPACITY: ALTER BI_CAPACITY statement. * ALTER_CAPACITY: ALTER CAPACITY statement. * ALTER_RESERVATION: ALTER RESERVATION statement. * SCRIPT: SCRIPT statement. * CALL: CALL statement. * BEGIN_TRANSACTION: BEGIN TRANSACTION statement. * COMMIT_TRANSACTION: COMMIT TRANSACTION statement. * ROLLBACK_TRANSACTION: ROLLBACK TRANSACTION statement. * EXPORT_DATA: EXPORT DATA statement. * EXPORT_MODEL: EXPORT MODEL statement. * EXPORT_METADATA: EXPORT TABLE METADATA statement, for BigLake Iceberg tables. * LOAD_DATA: LOAD DATA statement. * GRANT_ON_SCHEMA: GRANT ... ON SCHEMA statement. * GRANT_ON_TABLE: GRANT ... ON TABLE statement. Also used for GRANT ... ON EXTERNAL TABLE. * GRANT_ON_VIEW: GRANT ... ON VIEW statement. * GRANT_ON_PROJECT: GRANT ... ON PROJECT statement. * REVOKE_ON_SCHEMA: REVOKE ... ON SCHEMA statement. * REVOKE_ON_TABLE: REVOKE ... ON TABLE statement. Also used for REVOKE ... ON EXTERNAL TABLE. * REVOKE_ON_VIEW: REVOKE ... ON VIEW statement. * REVOKE_ON_PROJECT: REVOKE ... ON PROJECT statement.
timeline[]	object (QueryTimelineSample) Output only. Describes a timeline of job execution.
totalBytesBilled	string (int64 format) Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.
totalBytesProcessed	string (int64 format) Output only. Total bytes processed for the job.
totalBytesProcessedAccuracy	string Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
totalPartitionsProcessed	string (int64 format) Output only. Total number of partitions processed from all partitioned tables referenced in the job.
totalServicesSkuSlotMs	string (int64 format) Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU".
totalSlotMs	string (int64 format) Output only. Slot-milliseconds for the job.
transferredBytes	string (int64 format) Output only. Total bytes transferred for BigQuery Omni queries from the remote cloud back to Google Cloud. This tracks data movement over Google-managed connections (like query results). It doesn't include input data read from the external data lake (for example, S3) because that data stays within the remote cloud.
undeclaredQueryParameters[]	object (QueryParameter) Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
vectorSearchStatistics	object (VectorSearchStatistics) Output only. Vector Search query specific statistics.

JobStatistics3

Statistics for a load job.

Fields
badRecords	string (int64 format) Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
inputFileBytes	string (int64 format) Output only. Number of bytes of source data in a load job.
inputFiles	string (int64 format) Output only. Number of source files in a load job.
outputBytes	string (int64 format) Output only. Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
outputRows	string (int64 format) 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[]	object (QueryTimelineSample) Output only. Describes a timeline of job execution.

JobStatistics4

Statistics for an extract job.

Fields
destinationUriFileCounts[]	string (int64 format) Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
inputBytes	string (int64 format) 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[]	object (QueryTimelineSample) Output only. Describes a timeline of job execution.

JobStatistics5

Statistics for a copy job.

Fields
copiedLogicalBytes	string (int64 format) Output only. Number of logical bytes copied to the destination table.
copiedRows	string (int64 format) Output only. Number of rows copied to the destination table.
remoteDestinationRegion	string Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs.

JobStatus

(No description provided)

Fields
errorResult	object (ErrorProto) Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
errors[]	object (ErrorProto) Output only. The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has not completed or was unsuccessful.
state	string Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.

JoinRestrictionPolicy

Represents privacy policy associated with "join restrictions". Join restriction gives data providers the ability to enforce joins on the 'join_allowed_columns' when data is queried from a privacy protected view.

Fields
joinAllowedColumns[]	string Optional. The only columns that joins are allowed on. This field is must be specified for join_conditions JOIN_ANY and JOIN_ALL and it cannot be set for JOIN_BLOCKED.
joinCondition	enum Optional. Specifies if a join is required or not on queries for the view. Default is JOIN_CONDITION_UNSPECIFIED.
Enum type. Can be one of the following:
JOIN_CONDITION_UNSPECIFIED	A join is neither required nor restricted on any column. Default value.
JOIN_ANY	A join is required on at least one of the specified columns.
JOIN_ALL	A join is required on all specified columns.
JOIN_NOT_REQUIRED	A join is not required, but if present it is only permitted on 'join_allowed_columns'
JOIN_BLOCKED	Joins are blocked for all queries.

JsonOptions

Json Options for load and make external tables.

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

LinkedDatasetMetadata

Metadata about the Linked Dataset.

Fields
linkState	enum Output only. Specifies whether Linked Dataset is currently in a linked state or not.
Enum type. Can be one of the following:
LINK_STATE_UNSPECIFIED	The default value. Default to the LINKED state.
LINKED	Normal Linked Dataset state. Data is queryable via the Linked Dataset.
UNLINKED	Data publisher or owner has unlinked this Linked Dataset. It means you can no longer query or see the data in the Linked Dataset.

LinkedDatasetSource

A dataset source type which refers to another BigQuery dataset.

Fields
sourceDataset	object (DatasetReference) The source dataset reference contains project numbers and not project ids.

ListModelsResponse

Response format for a single page when listing BigQuery ML models.

Fields
models[]	object (Model) Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.
nextPageToken	string A token to request the next page of results.

ListRoutinesResponse

Describes the format of a single result page when listing routines.

Fields
nextPageToken	string A token to request the next page of results.
routines[]	object (Routine) Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, language, and remote_function_options.

ListRowAccessPoliciesResponse

Response message for the ListRowAccessPolicies method.

Fields
nextPageToken	string A token to request the next page of results.
rowAccessPolicies[]	object (RowAccessPolicy) Row access policies on the requested table.

LoadQueryStatistics

Statistics for a LOAD query.

Fields
badRecords	string (int64 format) Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
bytesTransferred	string (int64 format) Output only. This field is deprecated. The number of bytes of source data copied over the network for a LOAD query. transferred_bytes has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing.
inputFileBytes	string (int64 format) Output only. Number of bytes of source data in a LOAD query.
inputFiles	string (int64 format) Output only. Number of source files in a LOAD query.
outputBytes	string (int64 format) Output only. Size of the loaded data in bytes. Note that while a LOAD query is in the running state, this value may change.
outputRows	string (int64 format) 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.

LocationMetadata

BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.

Fields
legacyLocationId	string The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations.

MaterializedView

A materialized view considered for a query job.

Fields
chosen	boolean Whether the materialized view is chosen for the query. A materialized view can be chosen to rewrite multiple parts of the same query. If a materialized view is chosen to rewrite any part of the query, then this field is true, even if the materialized view was not chosen to rewrite others parts.
estimatedBytesSaved	string (int64 format) If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.
rejectedReason	enum If present, specifies the reason why the materialized view was not chosen for the query.
Enum type. Can be one of the following:
REJECTED_REASON_UNSPECIFIED	Default unspecified value.
NO_DATA	View has no cached data because it has not refreshed yet.
COST	The estimated cost of the view is more expensive than another view or the base table. Note: The estimate cost might not match the billed cost.
BASE_TABLE_TRUNCATED	View has no cached data because a base table is truncated.
BASE_TABLE_DATA_CHANGE	View is invalidated because of a data change in one or more base tables. It could be any recent change if the maxStaleness option is not set for the view, or otherwise any change outside of the staleness window.
BASE_TABLE_PARTITION_EXPIRATION_CHANGE	View is invalidated because a base table's partition expiration has changed.
BASE_TABLE_EXPIRED_PARTITION	View is invalidated because a base table's partition has expired.
BASE_TABLE_INCOMPATIBLE_METADATA_CHANGE	View is invalidated because a base table has an incompatible metadata change.
TIME_ZONE	View is invalidated because it was refreshed with a time zone other than that of the current job.
OUT_OF_TIME_TRAVEL_WINDOW	View is outside the time travel window.
BASE_TABLE_FINE_GRAINED_SECURITY_POLICY	View is inaccessible to the user because of a fine-grained security policy on one of its base tables.
BASE_TABLE_TOO_STALE	One of the view's base tables is too stale. For example, the cached metadata of a BigLake external table needs to be updated.
tableReference	object (TableReference) The candidate materialized view.

MaterializedViewDefinition

Definition and configuration of a materialized view.

Fields
allowNonIncrementalDefinition	boolean Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. Non-incremental materialized views support an expanded range of SQL queries. The allow_non_incremental_definition option can't be changed after the materialized view is created.
enableRefresh	boolean Optional. Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
lastRefreshTime	string (int64 format) Output only. The time when this materialized view was last refreshed, in milliseconds since the epoch.
maxStaleness	string (bytes format) [Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).
query	string Required. A query whose results are persisted.
refreshIntervalMs	string (int64 format) Optional. The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

MaterializedViewStatistics

Statistics of materialized views considered in a query job.

Fields
materializedView[]	object (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.

MaterializedViewStatus

Status of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message.

Fields
lastRefreshStatus	object (ErrorProto) Output only. Error result of the last automatic refresh. If present, indicates that the last automatic refresh was unsuccessful.
refreshWatermark	string (Timestamp format) Output only. Refresh watermark of materialized view. The base tables' data were collected into the materialized view cache until this time.

MetadataCacheStalenessInsight

Column Metadata Index staleness detailed infnormation.

Fields
avgPreviousStalenessMs	string (Duration format) Output only. Average column metadata index staleness of previous runs with the same query hash.
stalenessPercentageIncrease	number (double format) Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash.

MetadataCacheStatistics

Statistics for metadata caching in queried tables.

Fields
tableMetadataCacheUsage[]	object (TableMetadataCacheUsage) Set for the Metadata caching eligible tables referenced in the query.

MlStatistics

Job statistics specific to a BigQuery ML training job.

Fields
hparamTrials[]	object (HparamTuningTrial) Output only. Trials of a hyperparameter tuning job sorted by trial_id.
iterationResults[]	object (IterationResult) Results for all completed iterations. Empty for hyperparameter tuning jobs.
maxIterations	string (int64 format) 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	enum Output only. The type of the model that is being trained.
Enum type. Can be one of the following:
MODEL_TYPE_UNSPECIFIED	Default value.
LINEAR_REGRESSION	Linear regression model.
LOGISTIC_REGRESSION	Logistic regression based classification model.
KMEANS	K-means clustering model.
MATRIX_FACTORIZATION	Matrix factorization model.
DNN_CLASSIFIER	DNN classifier model.
TENSORFLOW	An imported TensorFlow model.
DNN_REGRESSOR	DNN regressor model.
XGBOOST	An imported XGBoost model.
BOOSTED_TREE_REGRESSOR	Boosted tree regressor model.
BOOSTED_TREE_CLASSIFIER	Boosted tree classifier model.
ARIMA	ARIMA model.
AUTOML_REGRESSOR	AutoML Tables regression model.
AUTOML_CLASSIFIER	AutoML Tables classification model.
PCA	Prinpical Component Analysis model.
DNN_LINEAR_COMBINED_CLASSIFIER	Wide-and-deep classifier model.
DNN_LINEAR_COMBINED_REGRESSOR	Wide-and-deep regressor model.
AUTOENCODER	Autoencoder model.
ARIMA_PLUS	New name for the ARIMA model.
ARIMA_PLUS_XREG	ARIMA with external regressors.
RANDOM_FOREST_REGRESSOR	Random forest regressor model.
RANDOM_FOREST_CLASSIFIER	Random forest classifier model.
TENSORFLOW_LITE	An imported TensorFlow Lite model.
ONNX	An imported ONNX model.
TRANSFORM_ONLY	Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions.
CONTRIBUTION_ANALYSIS	The contribution analysis model.
trainingType	enum Output only. Training type of the job.
Enum type. Can be one of the following:
TRAINING_TYPE_UNSPECIFIED	Unspecified training type.
SINGLE_TRAINING	Single training with fixed parameter space.
HPARAM_TUNING	Hyperparameter tuning training.

Model

(No description provided)

Fields
bestTrialId	string (int64 format) The best trial_id across all training runs.
creationTime	string (int64 format) Output only. The time when this model was created, in millisecs since the epoch.
defaultTrialId	string (int64 format) Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective hyperparameter tuning models, this is the best trial ID. For multi-objective hyperparameter tuning models, this is the smallest trial ID among all Pareto optimal trials.
description	string Optional. A user-friendly description of this model.
encryptionConfiguration	object (EncryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
etag	string Output only. A hash of this resource.
expirationTime	string (int64 format) Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
featureColumns[]	object (StandardSqlField) Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.
friendlyName	string Optional. A descriptive name for this model.
hparamSearchSpaces	object (HparamSearchSpaces) Output only. All hyperparameter search spaces in this model.
hparamTrials[]	object (HparamTuningTrial) Output only. Trials of a hyperparameter tuning model sorted by trial_id.
labelColumns[]	object (StandardSqlField) Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
labels	map (key: string, value: string) The labels associated with this model. You can use these to organize and group your models. 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.
lastModifiedTime	string (int64 format) Output only. The time when this model was last modified, in millisecs since the epoch.
location	string Output only. The geographic location where the model resides. This value is inherited from the dataset.
modelReference	object (ModelReference) Required. Unique identifier for this model.
modelType	enum Output only. Type of the model resource.
Enum type. Can be one of the following:
MODEL_TYPE_UNSPECIFIED	Default value.
LINEAR_REGRESSION	Linear regression model.
LOGISTIC_REGRESSION	Logistic regression based classification model.
KMEANS	K-means clustering model.
MATRIX_FACTORIZATION	Matrix factorization model.
DNN_CLASSIFIER	DNN classifier model.
TENSORFLOW	An imported TensorFlow model.
DNN_REGRESSOR	DNN regressor model.
XGBOOST	An imported XGBoost model.
BOOSTED_TREE_REGRESSOR	Boosted tree regressor model.
BOOSTED_TREE_CLASSIFIER	Boosted tree classifier model.
ARIMA	ARIMA model.
AUTOML_REGRESSOR	AutoML Tables regression model.
AUTOML_CLASSIFIER	AutoML Tables classification model.
PCA	Prinpical Component Analysis model.
DNN_LINEAR_COMBINED_CLASSIFIER	Wide-and-deep classifier model.
DNN_LINEAR_COMBINED_REGRESSOR	Wide-and-deep regressor model.
AUTOENCODER	Autoencoder model.
ARIMA_PLUS	New name for the ARIMA model.
ARIMA_PLUS_XREG	ARIMA with external regressors.
RANDOM_FOREST_REGRESSOR	Random forest regressor model.
RANDOM_FOREST_CLASSIFIER	Random forest classifier model.
TENSORFLOW_LITE	An imported TensorFlow Lite model.
ONNX	An imported ONNX model.
TRANSFORM_ONLY	Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions.
CONTRIBUTION_ANALYSIS	The contribution analysis model.
optimalTrialIds[]	string (int64 format) Output only. For single-objective hyperparameter tuning models, it only contains the best trial. For multi-objective hyperparameter tuning models, it contains all Pareto optimal trials sorted by trial_id.
remoteModelInfo	object (RemoteModelInfo) Output only. Remote model info
trainingRuns[]	object (TrainingRun) Information for all training runs in increasing order of start_time.
transformColumns[]	object (TransformColumn) Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.

ModelDefinition

(No description provided)

Fields
modelOptions	object Deprecated.
modelOptions.labels[]	string (No description provided)
modelOptions.lossType	string (No description provided)
modelOptions.modelType	string (No description provided)
trainingRuns[]	object (BqmlTrainingRun) Deprecated.

ModelExtractOptions

Options related to model extraction.

Fields
trialId	string (int64 format) The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = Model.defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.

ModelReference

Id path of a model.

Fields
datasetId	string Required. The ID of the dataset containing this model.
modelId	string Required. The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
projectId	string Required. The ID of the project containing this model.

MultiClassClassificationMetrics

Evaluation metrics for multi-class classification/classifier models.

Fields
aggregateClassificationMetrics	object (AggregateClassificationMetrics) Aggregate classification metrics.
confusionMatrixList[]	object (ConfusionMatrix) Confusion matrix at different thresholds.

ObjectStorageStats

Storage and caching statistics for object storage.

Fields
cacheBytesRead	string (int64 format) Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read.
cloudProvider	enum The cloud provider for this block of statistics.
Enum type. Can be one of the following:
CLOUD_PROVIDER_UNSPECIFIED	Unspecified cloud provider.
GCP	Google Cloud Platform.
AWS	Amazon Web Services.
AZURE	Microsoft Azure.
objectStorageBytesRead	string (int64 format) Total bytes read directly from the cloud provider's storage.

ParquetOptions

Parquet Options for load and make external tables.

Fields
enableListInference	boolean Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
enumAsString	boolean Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
mapTargetType	enum Optional. Indicates how to represent a Parquet map if present.
Enum type. Can be one of the following:
MAP_TARGET_TYPE_UNSPECIFIED	In this mode, the map will have the following schema: struct map_field_name { repeated struct key_value { key value } }.
ARRAY_OF_STRUCT	In this mode, the map will have the following schema: repeated struct map_field_name { key value }.

PartitionSkew

Partition skew detailed information.

Fields
skewSources[]	object (SkewSource) Output only. Source stages which produce skewed data.

PartitionedColumn

The partitioning column information.

Fields
field	string Required. The name of the partition column.

PartitioningDefinition

The partitioning information, which includes managed table, external table and metastore partitioned table partition information.

Fields

partitionedColumn[]

object (PartitionedColumn) Optional. Details about each partitioning column. This field is output only for all partitioning types other than metastore partitioned tables. BigQuery native tables only support 1 partitioning column. Other table types may support 0, 1 or more partitioning columns. For metastore partitioned tables, the order must match the definition order in the Hive Metastore, where it must match the physical layout of the table. For example, CREATE TABLE a_table(id BIGINT, name STRING) PARTITIONED BY (city STRING, state STRING). In this case the values must be ['city', 'state'] in that order.

PerformanceInsights

Performance insights for the job.

Fields
avgPreviousExecutionMs	string (int64 format) 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[]	object (StagePerformanceChangeInsight) Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.
stagePerformanceStandaloneInsights[]	object (StagePerformanceStandaloneInsight) Output only. Standalone query stage performance insights, for exploring potential improvements.
tableChangeInsights[]	object (TableChangeInsight) Output only. Performance insights for table-level attributes that changed compared to previous runs.

Policy

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

Fields
auditConfigs[]	object (AuditConfig) Specifies cloud audit logging configuration for this policy.
bindings[]	object (Binding) Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:[e-mail], and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
etag	string (bytes format) etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
version	integer (int32 format) Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

PrincipalComponentInfo

Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.

Fields
cumulativeExplainedVarianceRatio	number (double format) The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.
explainedVariance	number (double format) Explained variance by this principal component, which is simply the eigenvalue.
explainedVarianceRatio	number (double format) Explained_variance over the total explained variance.
principalComponentId	string (int64 format) Id of the principal component.

PrivacyPolicy

Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views.

Fields
aggregationThresholdPolicy	object (AggregationThresholdPolicy) Optional. Policy used for aggregation thresholds.
differentialPrivacyPolicy	object (DifferentialPrivacyPolicy) Optional. Policy used for differential privacy.
joinRestrictionPolicy	object (JoinRestrictionPolicy) Optional. Join restriction policy is outside of the one of policies, since this policy can be set along with other policies. This policy gives data providers the ability to enforce joins on the 'join_allowed_columns' when data is queried from a privacy protected view.

ProjectList

Response object of ListProjects

Fields
etag	string A hash of the page of results.
kind	string The resource type of the response.
nextPageToken	string Use this token to request the next page of results.
projects[]	object Projects to which the user has at least READ access. This field can be omitted if totalItems is 0.
projects.friendlyName	string A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string.
projects.id	string An opaque ID of this project.
projects.kind	string The resource type.
projects.numericId	string (uint64 format) The numeric ID of this project.
projects.projectReference	object (ProjectReference) A unique reference to this project.
totalItems	integer (int32 format) The total number of projects in the page. A wrapper is used here because the field should still be in the response when the value is 0.

ProjectReference

A unique reference to a project.

Fields
projectId	string Required. ID of the project. Can be either the numeric ID or the assigned ID of the project.

PropertyGraphReference

Id path of a property graph.

Fields
datasetId	string Required. The ID of the dataset containing this property graph.
projectId	string Required. The ID of the project containing this property graph.
propertyGraphId	string Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

PruningStats

The column metadata index pruning statistics.

Fields
postCmetaPruningParallelInputCount	string (int64 format) The number of parallel inputs matched.
postCmetaPruningPartitionCount	string (int64 format) The number of partitions matched.
preCmetaPruningParallelInputCount	string (int64 format) The number of parallel inputs scanned.

PythonOptions

Options for a user-defined Python function.

Fields
entryPoint	string Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked.
packages[]	string Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see Use third-party packages.

QueryInfo

Query optimization information for a QUERY job.

Fields
optimizationDetails	map (key: string, value: any) Output only. Information about query optimizations.

QueryParameter

A parameter given to a query.

Fields
name	string Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.
parameterType	object (QueryParameterType) Required. The type of this parameter.
parameterType.structTypes.description	string Optional. Human-oriented description of the field.
parameterType.structTypes.name	string Optional. The name of this field.
parameterType.structTypes.type	object (QueryParameterType) Required. The type of this field.
parameterValue	object (QueryParameterValue) Required. The value of this parameter.

QueryParameterType

The type of a query parameter.

Fields
arrayType	object (QueryParameterType) Optional. The type of the array's elements, if this is an array.
rangeElementType	object (QueryParameterType) Optional. The element type of the range, if this is a range.
structTypes[]	object Optional. The types of the fields of this struct, in order, if this is a struct.
structTypes.description	string Optional. Human-oriented description of the field.
structTypes.name	string Optional. The name of this field.
structTypes.type	object (QueryParameterType) Required. The type of this field.
timestampPrecision	string (int64 format) Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)
type	string Required. The top level type of this field.

QueryParameterValue

The value of a query parameter.

Fields
arrayValues[]	object (QueryParameterValue) Optional. The array values, if this is an array type.
rangeValue	object (RangeValue) Optional. The range value, if this is a range type.
structValues	map (key: string, value: object (QueryParameterValue)) The struct field values.
value	string Optional. The value of this value, if a simple scalar type.

QueryRequest

Describes the format of the jobs.query request.

Fields
arrowSerializationOptions	object (ArrowSerializationOptions) Optional. Options specific to the Apache Arrow output format.
connectionProperties[]	object (ConnectionProperty) Optional. Connection properties which can modify the query behavior.
continuous	boolean [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
createSession	boolean 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	object (DatasetReference) 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'.
destinationEncryptionConfiguration	object (EncryptionConfiguration) Optional. Custom encryption configuration (e.g., Cloud KMS keys)
dryRun	boolean 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	object (DataFormatOptions) Optional. Output format adjustments.
jobCreationMode	enum Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode.
Enum type. Can be one of the following:
JOB_CREATION_MODE_UNSPECIFIED	If unspecified JOB_CREATION_REQUIRED is the default.
JOB_CREATION_REQUIRED	Default. Job creation is always required.
JOB_CREATION_OPTIONAL	Job creation is optional. Returning immediate results is prioritized. BigQuery will automatically determine if a Job needs to be created. The conditions under which BigQuery can decide to not create a Job are subject to change. If Job creation is required, JOB_CREATION_REQUIRED mode should be used, which is the default.
jobTimeoutMs	string (int64 format) Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created.
kind	string The resource type of the request.
labels	map (key: string, value: string) 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.
location	string The geographic location where the job should run. For more information, see how to specify locations.
maxResults	integer (uint32 format) 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.
maxSlots	integer (int32 format) Optional. A target limit on the rate of slot consumption by this query. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this query to keep it below the configured limit, even if the query is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.
maximumBytesBilled	string (int64 format) 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	string GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserveNulls	boolean This property is deprecated.
query	string Required. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: "SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId".
queryParameters[]	object (QueryParameter) Query parameters for GoogleSQL queries.
queryResultsFormat	enum Optional. The query results format. If the value is anything other than STRUCT_ENCODING or unspecified: * The schema of the results will be provided in QueryResponse.results_schema field. * The results of the first page will be provided in QueryResponse.results field. * The QueryResponse.rows will not be populated. * The QueryResponse.schema for QueryResponse.rows will also not be populated since it is the schema of the QueryResponse.rows. This feature is not yet available.
Enum type. Can be one of the following:
QUERY_RESULTS_FORMAT_UNSPECIFIED	If unspecified it will default to struct QueryResponse.rows (STRUCT_ENCODING)
STRUCT_ENCODING	Default encoding of results as struct in QueryResponse.rows
ARROW	Arrow is a standard open source column-based message format. See https://arrow.apache.org/ for more details.
requestId	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.
reservation	string Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is projects/{project}/locations/{location}/reservations/{reservation}. Forces the query to use on-demand billing when set to none. This requires the project or organization to have reservation_override_mode set to ALLOW_ANY_OVERRIDE.
secureContext	object (SecureContext) Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query.
timeoutMs	integer (uint32 format) 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	boolean Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's GoogleSQL. When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
useQueryCache	boolean Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
writeIncrementalResults	boolean Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.

QueryResponse

(No description provided)

Fields
arrowRecordBatch	object (ArrowRecordBatch) Output only. Serialized row data in Arrow RecordBatch format.
arrowSchema	object (ArrowSchema) Output only. Arrow schema
cacheHit	boolean Whether the query result was fetched from the query cache.
creationTime	string (int64 format) Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries.
dmlStats	object (DmlStatistics) Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
endTime	string (int64 format) Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state.
errors[]	object (ErrorProto) 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.
jobComplete	boolean 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	object (JobCreationReason) Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset.
jobReference	object (JobReference) 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). If job_creation_mode was set to JOB_CREATION_OPTIONAL and the query completes without creating a job, this field will be empty.
kind	string The resource type.
location	string Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations
numDmlAffectedRows	string (int64 format) Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
pageRowCount	string (int64 format) Output only. The number of rows out of total_rows returned in this response. This feature is not yet available.
pageToken	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 method. For more information, see Paging through table data.
queryId	string Auto-generated ID for the query.
rows[]	object (TableRow) 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.
schema	object (TableSchema) The schema of the results. Present only when the query completes successfully.
sessionInfo	object (SessionInfo) Output only. Information of the session if this job is part of one.
startTime	string (int64 format) Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE.
statementType	string Output only. The type of query statement, if valid. Possible values: * SELECT: SELECT statement. * ASSERT: ASSERT statement. * INSERT: INSERT statement. * UPDATE: UPDATE statement. * DELETE: DELETE statement. * MERGE: MERGE statement. * TRUNCATE_TABLE: TRUNCATE TABLE statement. * CREATE_TABLE: CREATE TABLE statement, without AS SELECT. * CREATE_TABLE_AS_SELECT: CREATE TABLE AS SELECT statement. * CREATE_VIEW: CREATE VIEW statement. * CREATE_MODEL: CREATE MODEL statement. * CREATE_MATERIALIZED_VIEW: CREATE MATERIALIZED VIEW statement. * CREATE_FUNCTION: CREATE FUNCTION statement. * CREATE_TABLE_FUNCTION: CREATE TABLE FUNCTION statement. * CREATE_PROCEDURE: CREATE PROCEDURE statement. * CREATE_ROW_ACCESS_POLICY: CREATE ROW ACCESS POLICY statement. * CREATE_SCHEMA: CREATE SCHEMA statement. * CREATE_EXTERNAL_SCHEMA: CREATE EXTERNAL SCHEMA statement. * CREATE_EXTERNAL_TABLE: CREATE EXTERNAL TABLE statement. * CREATE_SNAPSHOT_TABLE: CREATE SNAPSHOT TABLE statement. * CREATE_SEARCH_INDEX: CREATE SEARCH INDEX statement. * CREATE_VECTOR_INDEX: CREATE VECTOR INDEX statement. * CREATE_CONNECTION: CREATE CONNECTION statement. * CREATE_DATA_POLICY: CREATE DATA_POLICY statement. * CREATE_PROPERTY_GRAPH: CREATE PROPERTY GRAPH statement. * CREATE_CAPACITY: CREATE CAPACITY statement. * CREATE_RESERVATION: CREATE RESERVATION statement. * CREATE_ASSIGNMENT: CREATE ASSIGNMENT statement. * DROP_TABLE: DROP TABLE statement. * DROP_EXTERNAL_TABLE: DROP EXTERNAL TABLE statement. * DROP_VIEW: DROP VIEW statement. * DROP_MODEL: DROP MODEL statement. * DROP_MATERIALIZED_VIEW: DROP MATERIALIZED VIEW statement. * DROP_FUNCTION: DROP FUNCTION statement. * DROP_TABLE_FUNCTION: DROP TABLE FUNCTION statement. * DROP_PROCEDURE: DROP PROCEDURE statement. * DROP_SEARCH_INDEX: DROP SEARCH INDEX statement. * DROP_VECTOR_INDEX: DROP VECTOR INDEX statement. * DROP_SCHEMA: DROP SCHEMA statement. * UNDROP_SCHEMA: UNDROP SCHEMA statement. * DROP_SNAPSHOT_TABLE: DROP SNAPSHOT TABLE statement. * DROP_ROW_ACCESS_POLICY: DROP [ALL] ROW ACCESS POLICY|POLICIES statement. * DROP_CONNECTION: DROP CONNECTION statement. * DROP_DATA_POLICY: DROP DATA_POLICY statement. * DROP_PROPERTY_GRAPH: DROP PROPERTY GRAPH statement. * DROP_CAPACITY: DROP CAPACITY statement. * DROP_RESERVATION: DROP RESERVATION statement. * DROP_ASSIGNMENT: DROP ASSIGNMENT statement. * ALTER_TABLE: ALTER TABLE statement. * ALTER_VIEW: ALTER VIEW statement. * ALTER_MATERIALIZED_VIEW: ALTER MATERIALIZED VIEW statement. * ALTER_SCHEMA: ALTER SCHEMA statement. * ALTER_MODEL: ALTER MODEL statement. * ALTER_SEARCH_INDEX: ALTER SEARCH INDEX statement. * ALTER_VECTOR_INDEX: ALTER VECTOR INDEX statement. * ALTER_CONNECTION: ALTER CONNECTION statement. * ALTER_DATA_POLICY: ALTER DATA_POLICY statement. * ALTER_PROJECT: ALTER PROJECT statement. * ALTER_ORGANIZATION: ALTER ORGANIZATION statement. * ALTER_BI_CAPACITY: ALTER BI_CAPACITY statement. * ALTER_CAPACITY: ALTER CAPACITY statement. * ALTER_RESERVATION: ALTER RESERVATION statement. * SCRIPT: SCRIPT statement. * CALL: CALL statement. * BEGIN_TRANSACTION: BEGIN TRANSACTION statement. * COMMIT_TRANSACTION: COMMIT TRANSACTION statement. * ROLLBACK_TRANSACTION: ROLLBACK TRANSACTION statement. * EXPORT_DATA: EXPORT DATA statement. * EXPORT_MODEL: EXPORT MODEL statement. * EXPORT_METADATA: EXPORT TABLE METADATA statement, for BigLake Iceberg tables. * LOAD_DATA: LOAD DATA statement. * GRANT_ON_SCHEMA: GRANT ... ON SCHEMA statement. * GRANT_ON_TABLE: GRANT ... ON TABLE statement. Also used for GRANT ... ON EXTERNAL TABLE. * GRANT_ON_VIEW: GRANT ... ON VIEW statement. * GRANT_ON_PROJECT: GRANT ... ON PROJECT statement. * REVOKE_ON_SCHEMA: REVOKE ... ON SCHEMA statement. * REVOKE_ON_TABLE: REVOKE ... ON TABLE statement. Also used for REVOKE ... ON EXTERNAL TABLE. * REVOKE_ON_VIEW: REVOKE ... ON VIEW statement. * REVOKE_ON_PROJECT: REVOKE ... ON PROJECT statement.
totalBytesBilled	string (int64 format) Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.
totalBytesProcessed	string (int64 format) 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	string (uint64 format) 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.
totalSlotMs	string (int64 format) Output only. Number of slot ms the user is actually billed for.

QueryTimelineSample

Summary of the state of query execution at a given time.

Fields
activeUnits	string (int64 format) Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
completedUnits	string (int64 format) Total parallel units of work completed by this query.
elapsedMs	string (int64 format) Milliseconds elapsed since the start of query execution.
estimatedRunnableUnits	string (int64 format) Units of work that can be scheduled immediately. Providing additional slots for these units of work will accelerate the query, if no other query in the reservation needs additional slots.
pendingUnits	string (int64 format) Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
shuffleRamUsageRatio	number (double format) Total shuffle usage ratio in shuffle RAM per reservation of this query. This will be provided for reservation customers only.
totalSlotMs	string (int64 format) Cumulative slot-ms consumed by the query.

RangePartitioning

(No description provided)

Fields
field	string Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.
range	object [Experimental] Defines the ranges for range partitioning.
range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
range.interval	string (int64 format) [Experimental] The width of each interval.
range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.

RangeValue

Represents the value of a range.

Fields
end	object (QueryParameterValue) Optional. The end value of the range. A missing value represents an unbounded end.
start	object (QueryParameterValue) Optional. The start value of the range. A missing value represents an unbounded start.

RankingMetrics

Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.

Fields
averageRank	number (double format) Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
meanAveragePrecision	number (double format) Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
meanSquaredError	number (double format) 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	number (double format) 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.

Fields
meanAbsoluteError	number (double format) Mean absolute error.
meanSquaredError	number (double format) Mean squared error.
meanSquaredLogError	number (double format) Mean squared log error.
medianAbsoluteError	number (double format) Median absolute error.
rSquared	number (double format) R^2 score. This corresponds to r2_score in ML.EVALUATE.

RemoteFunctionOptions

Options for a remote user-defined function.

Fields
connection	string Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: "projects/{projectId}/locations/{locationId}/connections/{connectionId}"
endpoint	string Endpoint of the user-provided remote service, e.g. https://us-east1-my_gcf_project.cloudfunctions.net/remote_add
maxBatchingRows	string (int64 format) Max number of rows in each batch sent to the remote service. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.
userDefinedContext	map (key: string, value: string) User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB.

RemoteModelInfo

Remote Model Info

Fields
connection	string Output only. Fully qualified name of the user-provided connection object of the remote model. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}"
endpoint	string Output only. The endpoint for remote model.
maxBatchingRows	string (int64 format) Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically.
remoteModelVersion	string Output only. The model version for LLM.
remoteServiceType	enum Output only. The remote service type for remote model.
Enum type. Can be one of the following:
REMOTE_SERVICE_TYPE_UNSPECIFIED	Unspecified remote service type.
CLOUD_AI_TRANSLATE_V3	V3 Cloud AI Translation API. See more details at Cloud Translation API.
CLOUD_AI_VISION_V1	V1 Cloud AI Vision API See more details at Cloud Vision API.
CLOUD_AI_NATURAL_LANGUAGE_V1	V1 Cloud AI Natural Language API. See more details at REST Resource: documents.
CLOUD_AI_SPEECH_TO_TEXT_V2	V2 Speech-to-Text API. See more details at Google Cloud Speech-to-Text V2 API
speechRecognizer	string Output only. The name of the speech recognizer to use for speech recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. Customers can specify this field at model creation. If not specified, a default recognizer projects/{model project}/locations/global/recognizers/_ will be used. See more details at recognizers

RestrictionConfig

(No description provided)

Fields
type	enum Output only. Specifies the type of dataset/table restriction.
Enum type. Can be one of the following:
RESTRICTION_TYPE_UNSPECIFIED	Should never be used.
RESTRICTED_DATA_EGRESS	Restrict data egress. See Data egress for more details.

Routine

A user-defined function or a stored procedure.

Fields
arguments[]	object (Argument) Optional.
buildStatus	object (RoutineBuildStatus) Output only. The build status of the routine. This field is only applicable to Python UDFs. Preview
creationTime	string (int64 format) Output only. The time when this routine was created, in milliseconds since the epoch.
dataGovernanceType	enum Optional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.
Enum type. Can be one of the following:
DATA_GOVERNANCE_TYPE_UNSPECIFIED	The data governance type is unspecified.
DATA_MASKING	The data governance type is data masking.
definitionBody	string Required. The body of the routine. For functions, this is the expression in the AS clause. If language = "SQL", it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language="JAVASCRIPT", it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks. If definition_body references another routine, then that routine must be fully qualified with its project ID.
description	string Optional. The description of the routine, if defined.
determinismLevel	enum Optional. The determinism level of the JavaScript UDF, if defined.
Enum type. Can be one of the following:
DETERMINISM_LEVEL_UNSPECIFIED	The determinism of the UDF is unspecified.
DETERMINISTIC	The UDF is deterministic, meaning that 2 function calls with the same inputs always produce the same result, even across 2 query runs.
NOT_DETERMINISTIC	The UDF is not deterministic.
etag	string Output only. A hash of this resource.
externalRuntimeOptions	object (ExternalRuntimeOptions) Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. Preview
importedLibraries[]	string Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
language	enum Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.
Enum type. Can be one of the following:
LANGUAGE_UNSPECIFIED	Default value.
SQL	SQL language.
JAVASCRIPT	JavaScript language.
PYTHON	Python language.
JAVA	Java language.
SCALA	Scala language.
lastModifiedTime	string (int64 format) Output only. The time when this routine was last modified, in milliseconds since the epoch.
pythonOptions	object (PythonOptions) Optional. Options for the Python UDF. Preview
remoteFunctionOptions	object (RemoteFunctionOptions) Optional. Remote function specific options.
returnTableType	object (StandardSqlTableType) Optional. Can be set only if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definition_body at query time in each query that references this routine. If present, then the columns in the evaluated table result will be cast to match the column types specified in return table type, at query time.
returnType	object (StandardSqlDataType) Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y); * CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1)); * CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1)); The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time). Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y); Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.
routineReference	object (RoutineReference) Required. Reference describing the ID of this routine.
routineType	enum Required. The type of routine.
Enum type. Can be one of the following:
ROUTINE_TYPE_UNSPECIFIED	Default value.
SCALAR_FUNCTION	Non-built-in persistent scalar function.
PROCEDURE	Stored procedure.
TABLE_VALUED_FUNCTION	Non-built-in persistent TVF.
AGGREGATE_FUNCTION	Non-built-in persistent aggregate function.
securityMode	enum Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.
Enum type. Can be one of the following:
SECURITY_MODE_UNSPECIFIED	The security mode of the routine is unspecified.
DEFINER	The routine is to be executed with the privileges of the user who defines it.
INVOKER	The routine is to be executed with the privileges of the user who invokes it.
sparkOptions	object (SparkOptions) Optional. Spark specific options.
strictMode	boolean Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If strictMode is set to TRUE, the procedure body is further checked for errors such as non-existent tables or columns. The CREATE PROCEDURE statement fails if the body fails any of these checks. If strictMode is set to FALSE, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify strictMode=FALSE to avoid non-existent procedure errors during validation. Default value is TRUE.

RoutineBuildStatus

The status of a routine build.

Fields
buildDuration	string (Duration format) Output only. The time taken for the image build. Populated only after the build succeeds or fails.
buildState	enum Output only. The current build state of the routine.
Enum type. Can be one of the following:
BUILD_STATE_UNSPECIFIED	Default value.
IN_PROGRESS	The build is in progress.
SUCCEEDED	The build has succeeded.
FAILED	The build has failed.
buildStateUpdateTime	string (Timestamp format) Output only. The time when the build state was updated last.
errorResult	object (ErrorProto) Output only. A result object that will be present only if the build has failed.
imageSizeBytes	string (int64 format) Output only. The size of the image in bytes. Populated only after the build succeeds.

RoutineReference

Id path of a routine.

Fields
datasetId	string Required. The ID of the dataset containing this routine.
projectId	string Required. The ID of the project containing this routine.
routineId	string Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

Row

A single row in the confusion matrix.

Fields
actualLabel	string The original label of this row.
entries[]	object (Entry) Info describing predicted label distribution.

RowAccessPolicy

Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.

Fields
creationTime	string (Timestamp format) Output only. The time when this row access policy was created, in milliseconds since the epoch.
etag	string Output only. A hash of this resource.
filterPredicate	string Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
grantees[]	string Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:[e-mail]": An email address that represents a specific Google account. - "serviceAccount:[e-mail]": An email address that represents a service account. - "group:[e-mail]": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
lastModifiedTime	string (Timestamp format) Output only. The time when this row access policy was last modified, in milliseconds since the epoch.
rowAccessPolicyReference	object (RowAccessPolicyReference) Required. Reference describing the ID of this row access policy.

RowAccessPolicyReference

Id path of a row access policy.

Fields
datasetId	string Required. The ID of the dataset containing this row access policy.
policyId	string Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
projectId	string Required. The ID of the project containing this row access policy.
tableId	string Required. The ID of the table containing this row access policy.

RowLevelSecurityStatistics

Statistics for row-level security.

Fields
rowLevelSecurityApplied	boolean Whether any accessed data was protected by row access policies.

ScriptOptions

Options related to script execution.

Fields
keyResultStatement	enum 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.
Enum type. Can be one of the following:
KEY_RESULT_STATEMENT_KIND_UNSPECIFIED	Default value.
LAST	The last result determines the key result.
FIRST_SELECT	The first SELECT statement determines the key result.
statementByteBudget	string (int64 format) Limit on the number of bytes billed per statement. Exceeding this budget results in an error.
statementTimeoutMs	string (int64 format) Timeout period for each statement in a script.

ScriptStackFrame

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.

Fields
endColumn	integer (int32 format) Output only. One-based end column.
endLine	integer (int32 format) Output only. One-based end line.
procedureId	string Output only. Name of the active procedure, empty if in a top-level script.
startColumn	integer (int32 format) Output only. One-based start column.
startLine	integer (int32 format) Output only. One-based start line.
text	string Output only. Text of the current statement/expression.

ScriptStatistics

Job statistics specific to the child job of a script.

Fields
evaluationKind	enum Whether this child job was a statement or expression.
Enum type. Can be one of the following:
EVALUATION_KIND_UNSPECIFIED	Default value.
STATEMENT	The statement appears directly in the script.
EXPRESSION	The statement evaluates an expression that appears in the script.
stackFrames[]	object (ScriptStackFrame) Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.

SearchStatistics

Statistics for a search query. Populated as part of JobStatistics2.

Fields
indexPruningStats[]	object (IndexPruningStats) Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.
indexUnusedReasons[]	object (IndexUnusedReason) When indexUsageMode is UNUSED or PARTIALLY_USED, this field explains why indexes were not used in all or part of the search query. If indexUsageMode is FULLY_USED, this field is not populated.
indexUsageMode	enum Specifies the index usage mode for the query.
Enum type. Can be one of the following:
INDEX_USAGE_MODE_UNSPECIFIED	Index usage mode not specified.
UNUSED	No search indexes were used in the search query. See [indexUnusedReasons] (/bigquery/docs/reference/rest/v2/Job#IndexUnusedReason) for detailed reasons.
PARTIALLY_USED	Part of the search query used search indexes. See [indexUnusedReasons] (/bigquery/docs/reference/rest/v2/Job#IndexUnusedReason) for why other parts of the query did not use search indexes.
FULLY_USED	The entire search query used search indexes.

SecureContext

A set of key-value pairs representing the secure context.

Fields
secureParameterEntries	map (key: string, value: any) Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query.

SerDeInfo

Serializer and deserializer information.

Fields
name	string Optional. Name of the SerDe. The maximum length is 256 characters.
parameters	map (key: string, value: string) Optional. Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
serializationLibrary	string Required. Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.

SessionInfo

[Preview] Information related to sessions.

Fields
sessionId	string Output only. The id of the session.

SetIamPolicyRequest

Request message for SetIamPolicy method.

Fields
policy	object (Policy) REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask	string (FieldMask format) OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

SkewSource

Details about source stages which produce skewed data.

Fields
outputBytesMax	string (int64 format) Output only. Max partition output size (in bytes) for this stage.
outputBytesMedian	string (int64 format) Output only. Median partition output size (in bytes) for this stage.
outputBytesP95	string (int64 format) Output only. 95-th percentile of partition output size (in bytes) for this stage.
stageId	string (int64 format) Output only. Stage id of the skew source stage.

SnapshotDefinition

Information about base table and snapshot time of the snapshot.

Fields
baseTableReference	object (TableReference) Required. Reference describing the ID of the table that was snapshot.
snapshotTime	string (date-time format) Required. The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

SparkLoggingInfo

Spark job logs can be filtered by these fields in Cloud Logging.

Fields
projectId	string Output only. Project ID where the Spark logs were written.
resourceType	string Output only. Resource type used for logging.

SparkOptions

Options for a user-defined Spark routine.

Fields
archiveUris[]	string Archive files to be extracted into the working directory of each executor. For more information about Apache Spark, see Apache Spark.
connection	string Fully qualified name of the user-provided Spark connection object. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}"
containerImage	string Custom container image for the runtime environment.
fileUris[]	string Files to be placed in the working directory of each executor. For more information about Apache Spark, see Apache Spark.
jarUris[]	string JARs to include on the driver and executor CLASSPATH. For more information about Apache Spark, see Apache Spark.
mainClass	string The fully qualified name of a class in jar_uris, for example, com.example.wordcount. Exactly one of main_class and main_jar_uri field should be set for Java/Scala language type.
mainFileUri	string The main file/jar URI of the Spark application. Exactly one of the definition_body field and the main_file_uri field must be set for Python. Exactly one of main_class and main_file_uri field should be set for Java/Scala language type.
properties	map (key: string, value: string) Configuration properties as a set of key/value pairs, which will be passed on to the Spark application. For more information, see Apache Spark and the procedure option list.
pyFileUris[]	string Python files to be placed on the PYTHONPATH for PySpark application. Supported file types: .py, .egg, and .zip. For more information about Apache Spark, see Apache Spark.
runtimeVersion	string Runtime version. If not specified, the default runtime version is used.

SparkStatistics

Statistics for a BigSpark query. Populated as part of JobStatistics2

Fields
endpoints	map (key: string, value: string) Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.
gcsStagingBucket	string Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The gcsStagingBucket bucket is inferred from the @@spark_proc_properties.staging_bucket system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * gs://[bucket_name]
kmsKeyName	string Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, @@spark_proc_properties.kms_key_name, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]
loggingInfo	object (SparkLoggingInfo) Output only. Logging info is used to generate a link to Cloud Logging.
sparkJobId	string Output only. Spark job ID if a Spark job is created successfully.
sparkJobLocation	string Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region.

StagePerformanceChangeInsight

Performance insights compared to the previous executions for a specific stage.

Fields
inputDataChange	object (InputDataChange) Output only. Input data change insight of the query stage.
stageId	string (int64 format) Output only. The stage id that the insight mapped to.

StagePerformanceStandaloneInsight

Standalone performance insights for a specific stage.

Fields
biEngineReasons[]	object (BiEngineReason) Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.
highCardinalityJoins[]	object (HighCardinalityJoin) Output only. High cardinality joins in the stage.
insufficientShuffleQuota	boolean Output only. True if the stage has insufficient shuffle quota.
partitionSkew	object (PartitionSkew) Output only. Partition skew in the stage.
slotContention	boolean Output only. True if the stage has a slot contention issue.
stageId	string (int64 format) Output only. The stage id that the insight mapped to.

StandardSqlDataType

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"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} }

Fields
arrayElementType	object (StandardSqlDataType) The type of the array's elements, if type_kind = "ARRAY".
rangeElementType	object (StandardSqlDataType) The type of the range's elements, if type_kind = "RANGE".
structType	object (StandardSqlStructType) The fields of this struct, in order, if type_kind = "STRUCT".
typeKind	enum Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").
Enum type. Can be one of the following:
TYPE_KIND_UNSPECIFIED	Invalid type.
INT64	Encoded as a string in decimal format.
BOOL	Encoded as a boolean "false" or "true".
FLOAT64	Encoded as a number, or string "NaN", "Infinity" or "-Infinity".
STRING	Encoded as a string value.
BYTES	Encoded as a base64 string per RFC 4648, section 4.
TIMESTAMP	Encoded as an RFC 3339 timestamp with mandatory "Z" time zone string: 1985-04-12T23:20:50.52Z
DATE	Encoded as RFC 3339 full-date format string: 1985-04-12
TIME	Encoded as RFC 3339 partial-time format string: 23:20:50.52
DATETIME	Encoded as RFC 3339 full-date "T" partial-time: 1985-04-12T23:20:50.52
INTERVAL	Encoded as fully qualified 3 part: 0-5 15 2:30:45.6
GEOGRAPHY	Encoded as WKT
NUMERIC	Encoded as a decimal string.
BIGNUMERIC	Encoded as a decimal string.
JSON	Encoded as a string.
ARRAY	Encoded as a list with types matching Type.array_type.
STRUCT	Encoded as a list with fields of type Type.struct_type[i]. List is used because a JSON object cannot have duplicate field names.
RANGE	Encoded as a pair with types matching range_element_type. Pairs must begin with "[", end with ")", and be separated by ", ".
UUID	Encoded as a string.

StandardSqlField

A field or a column.

Fields
name	string Optional. The name of this field. Can be absent for struct fields.
type	object (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).

StandardSqlStructType

The representation of a SQL STRUCT type.

Fields
fields[]	object (StandardSqlField) Fields within the struct.

StandardSqlTableType

A table type

Fields
columns[]	object (StandardSqlField) The columns in this table type

StorageDescriptor

Contains information about how a table's data is stored and accessed by open source query engines.

Fields
inputFormat	string Optional. Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
locationUri	string Optional. The physical location of the table (e.g. gs://spark-dataproc-data/pangea-data/case_sensitive/ or gs://spark-dataproc-data/pangea-data/*). The maximum length is 2056 bytes.
outputFormat	string Optional. Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
serdeInfo	object (SerDeInfo) Optional. Serializer and deserializer information.

StoredColumnsUnusedReason

If the stored column was not used, explain why.

Fields
code	enum Specifies the high-level reason for the unused scenario, each reason must have a code associated.
Enum type. Can be one of the following:
CODE_UNSPECIFIED	Default value.
STORED_COLUMNS_COVER_INSUFFICIENT	If stored columns do not fully cover the columns.
BASE_TABLE_HAS_RLS	If the base table has RLS (Row Level Security).
BASE_TABLE_HAS_CLS	If the base table has CLS (Column Level Security).
UNSUPPORTED_PREFILTER	If the provided prefilter is not supported.
INTERNAL_ERROR	If an internal error is preventing stored columns from being used.
OTHER_REASON	Indicates that the reason stored columns cannot be used in the query is not covered by any of the other StoredColumnsUnusedReason options.
message	string Specifies the detailed description for the scenario.
uncoveredColumns[]	string Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS.

StoredColumnsUsage

Indicates the stored columns usage in the query.

Fields
baseTable	object (TableReference) Specifies the base table.
isQueryAccelerated	boolean Specifies whether the query was accelerated with stored columns.
storedColumnsUnusedReasons[]	object (StoredColumnsUnusedReason) If stored columns were not used, explain why.

Streamingbuffer

(No description provided)

Fields
estimatedBytes	string (uint64 format) Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer.
estimatedRows	string (uint64 format) Output only. A lower-bound estimate of the number of rows currently in the streaming buffer.
oldestEntryTime	string (uint64 format) Output only. Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

StringHparamSearchSpace

Search space for string and enum.

Fields
candidates[]	string Canididates for the string or enum parameter in lower case.

SystemVariables

System variables given to a query.

Fields
types	map (key: string, value: object (StandardSqlDataType)) Output only. Data type for each system variable.
values	map (key: string, value: any) Output only. Value for each system variable.

Table

(No description provided)

Fields
biglakeConfiguration	object (BigLakeConfiguration) Optional. Specifies the configuration of a BigQuery table for Apache Iceberg.
cloneDefinition	object (CloneDefinition) Output only. Contains information about the clone. This value is set via the clone operation.
clustering	object (Clustering) Clustering specification for the table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
creationTime	string (int64 format) Output only. The time when this table was created, in milliseconds since the epoch.
defaultCollation	string Optional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
defaultRoundingMode	enum Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn't affect existing fields.
Enum type. Can be one of the following:
ROUNDING_MODE_UNSPECIFIED	Unspecified will default to using ROUND_HALF_AWAY_FROM_ZERO.
ROUND_HALF_AWAY_FROM_ZERO	ROUND_HALF_AWAY_FROM_ZERO rounds half values away from zero when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1 1.5, 1.6, 1.7, 1.8, 1.9 => 2
ROUND_HALF_EVEN	ROUND_HALF_EVEN rounds half values to the nearest even value when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1 1.5 => 2 1.6, 1.7, 1.8, 1.9 => 2 2.5 => 2
description	string Optional. A user-friendly description of this table.
encryptionConfiguration	object (EncryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys).
etag	string Output only. A hash of this resource.
expirationTime	string (int64 format) Optional. The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
externalCatalogTableOptions	object (ExternalCatalogTableOptions) Optional. Options defining open source compatible table.
externalDataConfiguration	object (ExternalDataConfiguration) Optional. Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
friendlyName	string Optional. A descriptive name for this table.
id	string Output only. An opaque ID uniquely identifying the table.
kind	string The type of resource ID.
labels	map (key: string, value: string) The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
lastModifiedTime	string (uint64 format) Output only. The time when this table was last modified, in milliseconds since the epoch.
location	string Output only. The geographic location where the table resides. This value is inherited from the dataset.
managedTableType	enum Optional. If set, overrides the default managed table type configured in the dataset.
Enum type. Can be one of the following:
MANAGED_TABLE_TYPE_UNSPECIFIED	No managed table type specified.
NATIVE	The managed table is a native BigQuery table.
BIGLAKE	The managed table is a BigLake table for Apache Iceberg in BigQuery.
materializedView	object (MaterializedViewDefinition) Optional. The materialized view definition.
materializedViewStatus	object (MaterializedViewStatus) Output only. The materialized view status.
maxStaleness	string Optional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.
model	object (ModelDefinition) Deprecated.
model.modelOptions.labels[]	string (No description provided)
model.modelOptions.lossType	string (No description provided)
model.modelOptions.modelType	string (No description provided)
numActiveLogicalBytes	string (int64 format) Output only. Number of logical bytes that are less than 90 days old.
numActivePhysicalBytes	string (int64 format) Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numBytes	string (int64 format) Output only. The size of this table in logical bytes, excluding any data in the streaming buffer.
numCurrentPhysicalBytes	string (int64 format) Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numLongTermBytes	string (int64 format) Output only. The number of logical bytes in the table that are considered "long-term storage".
numLongTermLogicalBytes	string (int64 format) Output only. Number of logical bytes that are more than 90 days old.
numLongTermPhysicalBytes	string (int64 format) Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numPartitions	string (int64 format) Output only. The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numPhysicalBytes	string (int64 format) Output only. The physical size of this table in bytes. This includes storage used for time travel.
numRows	string (uint64 format) Output only. The number of rows of data in this table, excluding any data in the streaming buffer.
numTimeTravelPhysicalBytes	string (int64 format) Output only. Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numTotalLogicalBytes	string (int64 format) Output only. Total number of logical bytes in the table or materialized view.
numTotalPhysicalBytes	string (int64 format) Output only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
partitionDefinition	object (PartitioningDefinition) Optional. The partition information for all table formats, including managed partitioned tables, hive partitioned tables, iceberg partitioned, and metastore partitioned tables. This field is only populated for metastore partitioned tables. For other table formats, this is an output only field.
rangePartitioning	object (RangePartitioning) If specified, configures range partitioning for this table.
rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
replicas[]	object (TableReference) Optional. Output only. Table references of all replicas currently active on the table.
requirePartitionFilter	boolean Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
resourceTags	map (key: string, value: string) [Optional] The tags associated with this table. Tag keys are globally unique. See additional information on tags. An object containing a list of "key": value pairs. The key is the namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production".
restrictions	object (RestrictionConfig) Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See Data egress for more details.
schema	object (TableSchema) Optional. Describes the schema of this table.
selfLink	string Output only. A URL that can be used to access this resource again.
snapshotDefinition	object (SnapshotDefinition) Output only. Contains information about the snapshot. This value is set via snapshot creation.
streamingBuffer	object (Streamingbuffer) Output only. Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
tableConstraints	object (TableConstraints) Optional. Tables Primary Key and Foreign Key information
tableConstraints.foreignKeys.columnReferences[]	object Required. The columns that compose the foreign key.
tableConstraints.foreignKeys.columnReferences.referencedColumn	string Required. The column in the primary key that are referenced by the referencing_column.
tableConstraints.foreignKeys.columnReferences.referencingColumn	string Required. The column that composes the foreign key.
tableConstraints.foreignKeys.name	string Optional. Set only if the foreign key constraint is named.
tableConstraints.foreignKeys.referencedTable	object (No description provided)
tableConstraints.foreignKeys.referencedTable.datasetId	string (No description provided)
tableConstraints.foreignKeys.referencedTable.projectId	string (No description provided)
tableConstraints.foreignKeys.referencedTable.tableId	string (No description provided)
tableConstraints.primaryKey.columns[]	string Required. The columns that are composed of the primary key constraint.
tableReference	object (TableReference) Required. Reference describing the ID of this table.
tableReplicationInfo	object (TableReplicationInfo) Optional. Table replication info for table created AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv
timePartitioning	object (TimePartitioning) If specified, configures time-based partitioning for this table.
type	string Output only. Describes the table type. The following values are supported: * TABLE: A normal BigQuery table. * VIEW: A virtual table defined by a SQL query. * EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. * MATERIALIZED_VIEW: A precomputed view defined by a SQL query. * SNAPSHOT: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on table snapshots. The default value is TABLE.
view	object (ViewDefinition) Optional. The view definition.

TableCell

(No description provided)

Fields
v	any (No description provided)

TableChangeInsight

Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table.

Fields
metadataCacheNotUsedButUsedPreviously	boolean Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash.
metadataCacheStalenessInsight	object (MetadataCacheStalenessInsight) Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash.
tableReference	object (TableReference) Output only. The table that was queried.

TableConstraints

The TableConstraints defines the primary key and foreign key.

Fields
foreignKeys[]	object Optional. Present only if the table has a foreign key. The foreign key is not enforced.
foreignKeys.columnReferences[]	object Required. The columns that compose the foreign key.
foreignKeys.columnReferences.referencedColumn	string Required. The column in the primary key that are referenced by the referencing_column.
foreignKeys.columnReferences.referencingColumn	string Required. The column that composes the foreign key.
foreignKeys.name	string Optional. Set only if the foreign key constraint is named.
foreignKeys.referencedTable	object (No description provided)
foreignKeys.referencedTable.datasetId	string (No description provided)
foreignKeys.referencedTable.projectId	string (No description provided)
foreignKeys.referencedTable.tableId	string (No description provided)
primaryKey	object Represents the primary key constraint on a table's columns.
primaryKey.columns[]	string Required. The columns that are composed of the primary key constraint.

TableDataInsertAllRequest

Request for sending a single streaming insert.

Fields
ignoreUnknownValues	boolean Optional. Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
kind	string Optional. The resource type of the response. The value is not checked at the backend. Historically, it has been set to "bigquery#tableDataInsertAllRequest" but you are not required to set it.
rows[]	object (No description provided)
rows.insertId	string Insertion ID for best-effort deduplication. This feature is not recommended, and users seeking stronger insertion semantics are encouraged to use other mechanisms such as the BigQuery Write API.
rows.json	object (JsonObject) Data for a single row.
skipInvalidRows	boolean Optional. Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
templateSuffix	string Optional. If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
traceId	string Optional. Unique request trace id. Used for debugging purposes only. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended.

TableDataInsertAllResponse

Describes the format of a streaming insert response.

Fields
insertErrors[]	object Describes specific errors encountered while processing the request.
insertErrors.errors[]	object (ErrorProto) Error information for the row indicated by the index property.
insertErrors.index	integer (uint32 format) The index of the row that error applies to.
kind	string Returns "bigquery#tableDataInsertAllResponse".

TableDataList

(No description provided)

Fields
etag	string A hash of this page of results.
kind	string The resource type of the response.
pageToken	string A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
rows[]	object (TableRow) Rows of results.
totalRows	string (int64 format) Total rows of the entire table. In order to show default value 0 we have to present it as string.

TableFieldSchema

A field in TableSchema

Fields
categories	object Deprecated.
categories.names[]	string Deprecated.
collation	string Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
dataGovernanceTagsInfo	object Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: * Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. * Patching behavior: Describes how this field behaves during a Table.patch schema update: * Unset: If the data_governance_tags_info field is omitted from the update request, the existing tags on the column are preserved. * Empty Field: To clear data governance tags from a column, send the data_governance_tags_info field as an empty object. This removes all tags from the column. * Updating tags: To replace an existing tag, send the field with the new tag.
dataGovernanceTagsInfo.dataGovernanceTags	map (key: string, value: string) Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "parent-id/pii" where parent-id is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See Tag definitions for more details. For example: "parent-id/pii": "sensitive", "myProject/cost_center": "sales"
dataPolicies[]	object (DataPolicyOption) Optional. Data policies attached to this field, used for field-level access control.
dataPolicyList	object (DataPolicyList) Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information.
defaultValueExpression	string Optional. A SQL expression to specify the default value for this field.
description	string Optional. The field description. The maximum length is 1,024 characters.
fields[]	object (TableFieldSchema) Optional. Describes the nested schema fields if the type property is set to RECORD.
foreignTypeDefinition	string Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.
generatedColumn	object (GeneratedColumn) Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields).
maxLength	string (int64 format) Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
mode	string Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
name	string Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
policyTags	object Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
policyTags.names[]	string 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.
precision	string (int64 format) Optional. Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: * Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] * Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: * If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. * If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): * If type = "NUMERIC": 1 ≤ precision ≤ 29. * If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
rangeElementType	object Represents the type of a field element.
rangeElementType.type	string Required. The type of a field element. For more information, see TableFieldSchema.type.
roundingMode	enum Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
Enum type. Can be one of the following:
ROUNDING_MODE_UNSPECIFIED	Unspecified will default to using ROUND_HALF_AWAY_FROM_ZERO.
ROUND_HALF_AWAY_FROM_ZERO	ROUND_HALF_AWAY_FROM_ZERO rounds half values away from zero when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1 1.5, 1.6, 1.7, 1.8, 1.9 => 2
ROUND_HALF_EVEN	ROUND_HALF_EVEN rounds half values to the nearest even value when applying precision and scale upon writing of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1 1.5 => 2 1.6, 1.7, 1.8, 1.9 => 2 2.5 => 2
scale	string (int64 format) Optional. See documentation for precision.
timestampPrecision	string (int64 format) Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)
type	string Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema.

TableList

Partial projection of the metadata for a given table in a list response.

Fields
etag	string A hash of this page of results.
kind	string The type of list.
nextPageToken	string A token to request the next page of results.
tables[]	object Tables in the requested dataset.
tables.clustering	object (Clustering) Clustering specification for this table, if configured.
tables.creationTime	string (int64 format) Output only. The time when this table was created, in milliseconds since the epoch.
tables.expirationTime	string (int64 format) The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
tables.friendlyName	string The user-friendly name for this table.
tables.id	string An opaque ID of the table.
tables.kind	string The resource type.
tables.labels	map (key: string, value: string) The labels associated with this table. You can use these to organize and group your tables.
tables.rangePartitioning	object (RangePartitioning) The range partitioning for this table.
tables.rangePartitioning.range.end	string (int64 format) [Experimental] The end of range partitioning, exclusive.
tables.rangePartitioning.range.interval	string (int64 format) [Experimental] The width of each interval.
tables.rangePartitioning.range.start	string (int64 format) [Experimental] The start of range partitioning, inclusive.
tables.requirePartitionFilter	boolean Optional. If set to true, queries including this table must specify a partition filter. This filter is used for partition elimination.
tables.tableReference	object (TableReference) A reference uniquely identifying table.
tables.timePartitioning	object (TimePartitioning) The time-based partitioning for this table.
tables.type	string The type of table.
tables.view	object Information about a logical view.
tables.view.privacyPolicy	object (PrivacyPolicy) Specifies the privacy policy for the view.
tables.view.useLegacySql	boolean True if view is defined in legacy SQL dialect, false if in GoogleSQL.
totalItems	integer (int32 format) The total number of tables in the dataset.

TableMetadataCacheUsage

Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.

Fields
explanation	string Free form human-readable reason metadata caching was unused for the job.
pruningStats	object (PruningStats) The column metadata index pruning statistics.
staleness	string (Duration format) Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).
tableReference	object (TableReference) Metadata caching eligible table referenced in the query.
tableType	string Table type.
unusedReason	enum Reason for not using metadata caching for the table.
Enum type. Can be one of the following:
UNUSED_REASON_UNSPECIFIED	Unused reasons not specified.
EXCEEDED_MAX_STALENESS	Metadata cache was outside the table's maxStaleness.
METADATA_CACHING_NOT_ENABLED	Metadata caching feature is not enabled. [Update BigLake tables] (/bigquery/docs/create-cloud-storage-table-biglake#update-biglake-tables) to enable the metadata caching.
OTHER_REASON	Other unknown reason.

TableReference

(No description provided)

Fields
datasetId	string Required. The ID of the dataset containing this table.
projectId	string Required. The ID of the project containing this table.
tableId	string Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see General Category. The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as sample_table$20190123.

TableReplicationInfo

Replication info of a table created using AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv

Fields
replicatedSourceLastRefreshTime	string (int64 format) Optional. Output only. If source is a materialized view, this field signifies the last refresh time of the source.
replicationError	object (ErrorProto) Optional. Output only. Replication error that will permanently stopped table replication.
replicationIntervalMs	string (int64 format) Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied.
replicationStatus	enum Optional. Output only. Replication status of configured replication.
Enum type. Can be one of the following:
REPLICATION_STATUS_UNSPECIFIED	Default value.
ACTIVE	Replication is Active with no errors.
SOURCE_DELETED	Source object is deleted.
PERMISSION_DENIED	Source revoked replication permissions.
UNSUPPORTED_CONFIGURATION	Source configuration doesn't allow replication.
sourceTable	object (TableReference) Required. Source table reference that is replicated.

TableRow

(No description provided)

Fields
f[]	object (TableCell) Represents a single row in the result set, consisting of one or more fields.

TableSchema

Schema of a table

Fields
fields[]	object (TableFieldSchema) Describes the fields in a table.
foreignTypeInfo	object (ForeignTypeInfo) Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition).

TestIamPermissionsRequest

Request message for TestIamPermissions method.

Fields
permissions[]	string The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Fields
permissions[]	string A subset of TestPermissionsRequest.permissions that the caller is allowed.

TimePartitioning

(No description provided)

Fields
expirationMs	string (int64 format) Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.
field	string Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.
requirePartitionFilter	boolean If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.
type	string Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.

TrainingOptions

Options used in model training.

Fields
activationFn	string Activation function of the neural nets.
adjustStepChanges	boolean If true, detect step changes and make data adjustment in the input time series.
approxGlobalFeatureContrib	boolean Whether to use approximate feature contribution method in XGBoost model explanation for global explain.
autoArima	boolean Whether to enable auto ARIMA or not.
autoArimaMaxOrder	string (int64 format) The max value of the sum of non-seasonal p and q.
autoArimaMinOrder	string (int64 format) The min value of the sum of non-seasonal p and q.
autoClassWeights	boolean Whether to calculate class weights automatically based on the popularity of each label.
batchSize	string (int64 format) Batch size for dnn models.
boosterType	enum Booster type for boosted tree models.
Enum type. Can be one of the following:
BOOSTER_TYPE_UNSPECIFIED	Unspecified booster type.
GBTREE	Gbtree booster.
DART	Dart booster.
budgetHours	number (double format) Budget in hours for AutoML training.
calculatePValues	boolean Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.
categoryEncodingMethod	enum Categorical feature encoding method.
Enum type. Can be one of the following:
ENCODING_METHOD_UNSPECIFIED	Unspecified encoding method.
ONE_HOT_ENCODING	Applies one-hot encoding.
LABEL_ENCODING	Applies label encoding.
DUMMY_ENCODING	Applies dummy encoding.
cleanSpikesAndDips	boolean If true, clean spikes and dips in the input time series.
colorSpace	enum Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.
Enum type. Can be one of the following:
COLOR_SPACE_UNSPECIFIED	Unspecified color space
RGB	RGB
HSV	HSV
YIQ	YIQ
YUV	YUV
GRAYSCALE	GRAYSCALE
colsampleBylevel	number (double format) Subsample ratio of columns for each level for boosted tree models.
colsampleBynode	number (double format) Subsample ratio of columns for each node(split) for boosted tree models.
colsampleBytree	number (double format) Subsample ratio of columns when constructing each tree for boosted tree models.
contributionMetric	string The contribution metric. Applies to contribution analysis models. Allowed formats supported are for summable and summable ratio contribution metrics. These include expressions such as SUM(x) or SUM(x)/SUM(y), where x and y are column names from the base table.
dartNormalizeType	enum Type of normalization algorithm for boosted tree models using dart booster.
Enum type. Can be one of the following:
DART_NORMALIZE_TYPE_UNSPECIFIED	Unspecified dart normalize type.
TREE	New trees have the same weight of each of dropped trees.
FOREST	New trees have the same weight of sum of dropped trees.
dataFrequency	enum The data frequency of a time series.
Enum type. Can be one of the following:
DATA_FREQUENCY_UNSPECIFIED	Default value.
AUTO_FREQUENCY	Automatically inferred from timestamps.
YEARLY	Yearly data.
QUARTERLY	Quarterly data.
MONTHLY	Monthly data.
WEEKLY	Weekly data.
DAILY	Daily data.
HOURLY	Hourly data.
PER_MINUTE	Per-minute data.
dataSplitColumn	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	number (double format) 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	enum The data split type for training and evaluation, e.g. RANDOM.
Enum type. Can be one of the following:
DATA_SPLIT_METHOD_UNSPECIFIED	Default value.
RANDOM	Splits data randomly.
CUSTOM	Splits data with the user provided tags.
SEQUENTIAL	Splits data sequentially.
NO_SPLIT	Data split will be skipped.
AUTO_SPLIT	Splits data automatically: Uses NO_SPLIT if the data size is small. Otherwise uses RANDOM.
decomposeTimeSeries	boolean If true, perform decompose time series and save the results.
dimensionIdColumns[]	string Optional. Names of the columns to slice on. Applies to contribution analysis models.
distanceType	enum Distance type for clustering models.
Enum type. Can be one of the following:
DISTANCE_TYPE_UNSPECIFIED	Default value.
EUCLIDEAN	Eculidean distance.
COSINE	Cosine distance.
dropout	number (double format) Dropout probability for dnn models.
earlyStop	boolean 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	boolean If true, enable global explanation during training.
endpointIdleTtl	string (Duration format) The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours.
feedbackType	enum Feedback type that specifies which algorithm to run for matrix factorization.
Enum type. Can be one of the following:
FEEDBACK_TYPE_UNSPECIFIED	Default value.
IMPLICIT	Use weighted-als for implicit feedback problems.
EXPLICIT	Use nonweighted-als for explicit feedback problems.
fitIntercept	boolean Whether the model should include intercept during model training.
forecastLimitLowerBound	number (double format) The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html
forecastLimitUpperBound	number (double format) The forecast limit upper bound that was used during ARIMA model training with limits.
hiddenUnits[]	string (int64 format) Hidden units for dnn models.
holidayRegion	enum 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.
Enum type. Can be one of the following:
HOLIDAY_REGION_UNSPECIFIED	Holiday region unspecified.
GLOBAL	Global.
NA	North America.
JAPAC	Japan and Asia Pacific: Korea, Greater China, India, Australia, and New Zealand.
EMEA	Europe, the Middle East and Africa.
LAC	Latin America and the Caribbean.
AE	United Arab Emirates
AR	Argentina
AT	Austria
AU	Australia
BE	Belgium
BR	Brazil
CA	Canada
CH	Switzerland
CL	Chile
CN	China
CO	Colombia
CS	Czechoslovakia
CZ	Czech Republic
DE	Germany
DK	Denmark
DZ	Algeria
EC	Ecuador
EE	Estonia
EG	Egypt
ES	Spain
FI	Finland
FR	France
GB	Great Britain (United Kingdom)
GR	Greece
HK	Hong Kong
HU	Hungary
ID	Indonesia
IE	Ireland
IL	Israel
IN	India
IR	Iran
IT	Italy
JP	Japan
KR	Korea (South)
LV	Latvia
MA	Morocco
MX	Mexico
MY	Malaysia
NG	Nigeria
NL	Netherlands
NO	Norway
NZ	New Zealand
PE	Peru
PH	Philippines
PK	Pakistan
PL	Poland
PT	Portugal
RO	Romania
RS	Serbia
RU	Russian Federation
SA	Saudi Arabia
SE	Sweden
SG	Singapore
SI	Slovenia
SK	Slovakia
TH	Thailand
TR	Turkey
TW	Taiwan
UA	Ukraine
US	United States
VE	Venezuela
VN	Vietnam
ZA	South Africa
holidayRegions[]	string A list of geographical regions that are used for time series modeling.
horizon	string (int64 format) The number of periods ahead that need to be forecasted.
hparamTuningObjectives[]	string The target evaluation metrics to optimize the hyperparameters for.
huggingFaceModelId	string The id of a Hugging Face model. For example, google/gemma-2-2b-it.
includeDrift	boolean Include drift when fitting an ARIMA model.
initialLearnRate	number (double format) Specifies the initial learning rate for the line search learn rate strategy.
inputLabelColumns[]	string Name of input label columns in training data.
instanceWeightColumn	string Name of the instance weight column for training data. This column isn't be used as a feature.
integratedGradientsNumSteps	string (int64 format) Number of integral steps for the integrated gradients explain method.
isTestColumn	string Name of the column used to determine the rows corresponding to control and test. Applies to contribution analysis models.
itemColumn	string Item column specified for matrix factorization models.
kmeansInitializationColumn	string The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
kmeansInitializationMethod	enum The method used to initialize the centroids for kmeans algorithm.
Enum type. Can be one of the following:
KMEANS_INITIALIZATION_METHOD_UNSPECIFIED	Unspecified initialization method.
RANDOM	Initializes the centroids randomly.
CUSTOM	Initializes the centroids using data specified in kmeans_initialization_column.
KMEANS_PLUS_PLUS	Initializes with kmeans++.
l1RegActivation	number (double format) L1 regularization coefficient to activations.
l1Regularization	number (double format) L1 regularization coefficient.
l2Regularization	number (double format) L2 regularization coefficient.
labelClassWeights	map (key: string, value: number (double format)) Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
learnRate	number (double format) Learning rate in training. Used only for iterative training algorithms.
learnRateStrategy	enum The strategy to determine learn rate for the current iteration.
Enum type. Can be one of the following:
LEARN_RATE_STRATEGY_UNSPECIFIED	Default value.
LINE_SEARCH	Use line search to determine learning rate.
CONSTANT	Use a constant learning rate.
lossType	enum Type of loss function used during training run.
Enum type. Can be one of the following:
LOSS_TYPE_UNSPECIFIED	Default value.
MEAN_SQUARED_LOSS	Mean squared loss, used for linear regression.
MEAN_LOG_LOSS	Mean log loss, used for logistic regression.
machineType	string The type of the machine used to deploy and serve the model.
maxIterations	string (int64 format) The maximum number of iterations in training. Used only for iterative training algorithms.
maxParallelTrials	string (int64 format) Maximum number of trials to run in parallel.
maxReplicaCount	string (int64 format) The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count.
maxTimeSeriesLength	string (int64 format) 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	string (int64 format) Maximum depth of a tree for boosted tree models.
minAprioriSupport	number (double format) The apriori support minimum. Applies to contribution analysis models.
minRelativeProgress	number (double format) When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
minReplicaCount	string (int64 format) The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1.
minSplitLoss	number (double format) Minimum split loss for boosted tree models.
minTimeSeriesLength	string (int64 format) 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	string (int64 format) Minimum sum of instance weight needed in a child for boosted tree models.
modelGardenModelName	string The name of a Vertex model garden publisher model. Format is publishers/{publisher}/models/{model}@{optional_version_id}.
modelRegistry	enum The model registry.
Enum type. Can be one of the following:
MODEL_REGISTRY_UNSPECIFIED	Default value.
VERTEX_AI	Vertex AI.
modelUri	string Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
nonSeasonalOrder	object (ArimaOrder) 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.
numClusters	string (int64 format) Number of clusters for clustering models.
numFactors	string (int64 format) Num factors specified for matrix factorization models.
numParallelTree	string (int64 format) Number of parallel trees constructed during each iteration for boosted tree models.
numPrincipalComponents	string (int64 format) Number of principal components to keep in the PCA model. Must be <= the number of features.
numTrials	string (int64 format) Number of trials to run this hyperparameter tuning job.
optimizationStrategy	enum Optimization strategy for training linear regression models.
Enum type. Can be one of the following:
OPTIMIZATION_STRATEGY_UNSPECIFIED	Default value.
BATCH_GRADIENT_DESCENT	Uses an iterative batch gradient descent algorithm.
NORMAL_EQUATION	Uses a normal equation to solve linear regression problem.
optimizer	string Optimizer used for training the neural nets.
pcaExplainedVarianceRatio	number (double format) The minimum ratio of cumulative explained variance that needs to be given by the PCA model.
pcaSolver	enum The solver for PCA.
Enum type. Can be one of the following:
UNSPECIFIED	Default value.
FULL	Full eigen-decoposition.
RANDOMIZED	Randomized SVD.
AUTO	Auto.
reservationAffinityKey	string Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
reservationAffinityType	enum Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is NO_RESERVATION.
Enum type. Can be one of the following:
RESERVATION_AFFINITY_TYPE_UNSPECIFIED	Default value.
NO_RESERVATION	No reservation.
ANY_RESERVATION	Any reservation.
SPECIFIC_RESERVATION	Specific reservation.
reservationAffinityValues[]	string Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block.
sampledShapleyNumPaths	string (int64 format) Number of paths for the sampled Shapley explain method.
scaleFeatures	boolean If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.
standardizeFeatures	boolean Whether to standardize numerical features. Default to true.
subsample	number (double format) Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
tfVersion	string Based on the selected TF version, the corresponding docker image is used to train external models.
timeSeriesDataColumn	string Column to be designated as time series data for ARIMA model.
timeSeriesIdColumn	string The time series id column that was used during ARIMA model training.
timeSeriesIdColumns[]	string The time series id columns that were used during ARIMA model training.
timeSeriesLengthFraction	number (double format) 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	string Column to be designated as time series timestamp for ARIMA model.
treeMethod	enum Tree construction algorithm for boosted tree models.
Enum type. Can be one of the following:
TREE_METHOD_UNSPECIFIED	Unspecified tree method.
AUTO	Use heuristic to choose the fastest method.
EXACT	Exact greedy algorithm.
APPROX	Approximate greedy algorithm using quantile sketch and gradient histogram.
HIST	Fast histogram optimized approximate greedy algorithm.
trendSmoothingWindowSize	string (int64 format) 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	string User column specified for matrix factorization models.
vertexAiModelVersionAliases[]	string The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.
walsAlpha	number (double format) Hyperparameter for matrix factoration when implicit feedback type is specified.
warmStart	boolean Whether to train a model from the last checkpoint.
xgboostVersion	string User-selected XGBoost versions for training of XGBoost models.

TrainingRun

Information about a single training query run for the model.

Fields
classLevelGlobalExplanations[]	object (GlobalExplanation) Output only. Global explanation contains the explanation of top features on the class level. Applies to classification models only.
dataSplitResult	object (DataSplitResult) Output only. Data split result of the training run. Only set when the input data is actually split.
evaluationMetrics	object (EvaluationMetrics) Output only. The evaluation metrics over training/eval data that were computed at the end of training.
modelLevelGlobalExplanation	object (GlobalExplanation) Output only. Global explanation contains the explanation of top features on the model level. Applies to both regression and classification models.
results[]	object (IterationResult) Output only. Output of each iteration run, results.size() <= max_iterations.
startTime	string (Timestamp format) Output only. The start time of this training run.
trainingOptions	object (TrainingOptions) Output only. Options that were used for this training run, includes user specified and default options that were used.
trainingStartTime	string (int64 format) Output only. The start time of this training run, in milliseconds since epoch.
vertexAiModelId	string The model id in the Vertex AI Model Registry for this training run.
vertexAiModelVersion	string Output only. The model version in the Vertex AI Model Registry for this training run.

TransactionInfo

[Alpha] Information of a multi-statement transaction.

Fields
transactionId	string Output only. [Alpha] Id of the transaction.

TransformColumn

Information about a single transform column.

Fields
name	string Output only. Name of the column.
transformSql	string Output only. The SQL expression used in the column transform.
type	object (StandardSqlDataType) Output only. Data type of the column after the transform.

UndeleteDatasetRequest

Request format for undeleting a dataset.

Fields
deletionTime	string (Timestamp format) Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. Undeleting a dataset using deletion time is not supported.

UserDefinedFunctionResource

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

Fields
inlineCode	string [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
resourceUri	string [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

VectorSearchStatistics

Statistics for a vector search query. Populated as part of JobStatistics2.

Fields
indexUnusedReasons[]	object (IndexUnusedReason) When indexUsageMode is UNUSED or PARTIALLY_USED, this field explains why indexes were not used in all or part of the vector search query. If indexUsageMode is FULLY_USED, this field is not populated.
indexUsageMode	enum Specifies the index usage mode for the query.
Enum type. Can be one of the following:
INDEX_USAGE_MODE_UNSPECIFIED	Index usage mode not specified.
UNUSED	No vector indexes were used in the vector search query. See [indexUnusedReasons] (/bigquery/docs/reference/rest/v2/Job#IndexUnusedReason) for detailed reasons.
PARTIALLY_USED	Part of the vector search query used vector indexes. See [indexUnusedReasons] (/bigquery/docs/reference/rest/v2/Job#IndexUnusedReason) for why other parts of the query did not use vector indexes.
FULLY_USED	The entire vector search query used vector indexes.
storedColumnsUsages[]	object (StoredColumnsUsage) Specifies the usage of stored columns in the query when stored columns are used in the query.

ViewDefinition

Describes the definition of a logical view.

Fields
foreignDefinitions[]	object (ForeignViewDefinition) Optional. Foreign view representations.
privacyPolicy	object (PrivacyPolicy) Optional. Specifies the privacy policy for the view.
query	string Required. A query that BigQuery executes when the view is referenced.
useExplicitColumnNames	boolean True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1, c2) AS ...' syntax. Can only be set for GoogleSQL views.
useLegacySql	boolean Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view uses BigQuery's GoogleSQL. Queries and views that reference this view must use the same flag value. A wrapper is used here because the default value is True.
userDefinedFunctionResources[]	object (UserDefinedFunctionResource) Describes user-defined function resources used in the query.