@maxim_mazurok/gapi.client.bigquery-v2 0.0.20231208 → 0.0.20240124

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +1471 -750
  2. package/package.json +1 -1
  3. package/readme.md +18 -10
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://bigquery.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20231208
12
+ // Revision: 20240124
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -157,70 +157,73 @@ declare namespace gapi.client {
157
157
  logType?: string;
158
158
  }
159
159
  interface AvroOptions {
160
- /** [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). */
160
+ /** 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). */
161
161
  useAvroLogicalTypes?: boolean;
162
162
  }
163
163
  interface BiEngineReason {
164
- /** [Output-only] High-level BI Engine reason for partial or disabled acceleration. */
164
+ /** Output only. High-level BI Engine reason for partial or disabled acceleration */
165
165
  code?: string;
166
- /** [Output-only] Free form human-readable reason for partial or disabled acceleration. */
166
+ /** Output only. Free form human-readable reason for partial or disabled acceleration. */
167
167
  message?: string;
168
168
  }
169
169
  interface BiEngineStatistics {
170
- /** [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). */
170
+ /** Output only. Specifies which mode of BI Engine acceleration was performed (if any). */
171
171
  accelerationMode?: string;
172
- /** [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). */
172
+ /** Output only. Specifies which mode of BI Engine acceleration was performed (if any). */
173
173
  biEngineMode?: string;
174
174
  /** 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. */
175
175
  biEngineReasons?: BiEngineReason[];
176
176
  }
177
177
  interface BigLakeConfiguration {
178
- /** [Required] Required and immutable. Credential reference for accessing external storage system. Normalized as project_id.location_id.connection_id. */
178
+ /** Required. 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\_id>.<location\_id>.<connection\_id>" or "projects/<project\_id>/locations/<location\_id>/connections/<connection\_id>". */
179
179
  connectionId?: string;
180
- /** [Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported. */
180
+ /** Required. The file format the table data is stored in. */
181
181
  fileFormat?: string;
182
- /** [Required] Required and immutable. Fully qualified location prefix of the external folder where data is stored. Normalized to standard format: "gs:////". Starts with "gs://" rather than "/bigstore/". Ends with "/". Does not contain "*". See also BigLakeStorageMetadata on how it is used. */
182
+ /** Required. 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/" */
183
183
  storageUri?: string;
184
- /** [Required] Required and immutable. Open source file format that the table data is stored in. Currently only PARQUET is supported. */
184
+ /** Required. The table format the metadata only snapshots are stored in. */
185
185
  tableFormat?: string;
186
186
  }
187
187
  interface BigQueryModelTraining {
188
- /** [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. */
188
+ /** Deprecated. */
189
189
  currentIteration?: number;
190
- /** [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. */
190
+ /** Deprecated. */
191
191
  expectedTotalIterations?: string;
192
192
  }
193
193
  interface BigtableColumn {
194
- /** [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. */
194
+ /** Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. */
195
195
  encoding?: string;
196
- /** [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. */
196
+ /** 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. */
197
197
  fieldName?: string;
198
- /** [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. */
198
+ /** 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. */
199
199
  onlyReadLatest?: boolean;
200
- /** [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. */
200
+ /** [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. */
201
201
  qualifierEncoded?: string;
202
+ /** Qualifier string. */
202
203
  qualifierString?: string;
203
- /** [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. */
204
+ /** 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. */
204
205
  type?: string;
205
206
  }
206
207
  interface BigtableColumnFamily {
207
- /** [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. */
208
+ /** Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. */
208
209
  columns?: BigtableColumn[];
209
- /** [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
210
+ /** Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
210
211
  encoding?: string;
211
212
  /** Identifier of the column family. */
212
213
  familyId?: string;
213
- /** [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. */
214
+ /** 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. */
214
215
  onlyReadLatest?: boolean;
215
- /** [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. */
216
+ /** 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. */
216
217
  type?: string;
217
218
  }
218
219
  interface BigtableOptions {
219
- /** [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. */
220
+ /** 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. */
220
221
  columnFamilies?: BigtableColumnFamily[];
221
- /** [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. */
222
+ /** 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. */
222
223
  ignoreUnspecifiedColumnFamilies?: boolean;
223
- /** [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. */
224
+ /** 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. */
225
+ outputColumnFamiliesAsJson?: boolean;
226
+ /** 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. */
224
227
  readRowkeyAsString?: boolean;
225
228
  }
226
229
  interface BinaryClassificationMetrics {
@@ -256,31 +259,31 @@ declare namespace gapi.client {
256
259
  interface Binding {
257
260
  /** 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](https://cloud.google.com/iam/help/conditions/resource-policies). */
258
261
  condition?: Expr;
259
- /** 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. */
262
+ /** 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `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`. */
260
263
  members?: string[];
261
- /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
264
+ /** 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](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). */
262
265
  role?: string;
263
266
  }
264
267
  interface BqmlIterationResult {
265
- /** [Output-only, Beta] Time taken to run the training iteration in milliseconds. */
268
+ /** Deprecated. */
266
269
  durationMs?: string;
267
- /** [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows. */
270
+ /** Deprecated. */
268
271
  evalLoss?: number;
269
- /** [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run. */
272
+ /** Deprecated. */
270
273
  index?: number;
271
- /** [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant. */
274
+ /** Deprecated. */
272
275
  learnRate?: number;
273
- /** [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type. */
276
+ /** Deprecated. */
274
277
  trainingLoss?: number;
275
278
  }
276
279
  interface BqmlTrainingRun {
277
- /** [Output-only, Beta] List of each iteration results. */
280
+ /** Deprecated. */
278
281
  iterationResults?: BqmlIterationResult[];
279
- /** [Output-only, Beta] Training run start time in milliseconds since the epoch. */
282
+ /** Deprecated. */
280
283
  startTime?: string;
281
- /** [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user. */
284
+ /** Deprecated. */
282
285
  state?: string;
283
- /** [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run. */
286
+ /** Deprecated. */
284
287
  trainingOptions?: {
285
288
  earlyStop?: boolean;
286
289
  l1Reg?: number;
@@ -304,9 +307,9 @@ declare namespace gapi.client {
304
307
  count?: string;
305
308
  }
306
309
  interface CloneDefinition {
307
- /** [Required] Reference describing the ID of the table that was cloned. */
310
+ /** Required. Reference describing the ID of the table that was cloned. */
308
311
  baseTableReference?: TableReference;
309
- /** [Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format. */
312
+ /** Required. The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format. */
310
313
  cloneTime?: string;
311
314
  }
312
315
  interface Cluster {
@@ -326,7 +329,7 @@ declare namespace gapi.client {
326
329
  clusterSize?: string;
327
330
  }
328
331
  interface Clustering {
329
- /** [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. */
332
+ /** One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. Additional information on limitations can be found here: https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations */
330
333
  fields?: string[];
331
334
  }
332
335
  interface ClusteringMetrics {
@@ -344,35 +347,39 @@ declare namespace gapi.client {
344
347
  rows?: Row[];
345
348
  }
346
349
  interface ConnectionProperty {
347
- /** [Required] Name of the connection property to set. */
350
+ /** The key of the property to set. */
348
351
  key?: string;
349
- /** [Required] Value of the connection property. */
352
+ /** The value of the property to set. */
350
353
  value?: string;
351
354
  }
352
355
  interface CsvOptions {
353
- /** [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. */
356
+ /** 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. */
354
357
  allowJaggedRows?: boolean;
355
- /** [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */
358
+ /** Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */
356
359
  allowQuotedNewlines?: boolean;
357
- /** [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. */
360
+ /** 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. */
358
361
  encoding?: string;
359
- /** [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */
362
+ /** 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). */
360
363
  fieldDelimiter?: string;
361
- /** [Optional] An custom string that will represent a NULL value in CSV import data. */
364
+ /** [Optional] A custom string that will represent a NULL value in CSV import data. */
362
365
  nullMarker?: string;
363
- /** [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats. */
366
+ /** Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. */
364
367
  preserveAsciiControlCharacters?: boolean;
365
- /** [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. */
368
+ /** 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 ' "" '. */
366
369
  quote?: string;
367
- /** [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. */
370
+ /** 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. */
368
371
  skipLeadingRows?: string;
369
372
  }
373
+ interface DataFormatOptions {
374
+ /** Optional. Output timestamp as usec int64. Default is false. */
375
+ useInt64Timestamp?: boolean;
376
+ }
370
377
  interface DataMaskingStatistics {
371
- /** [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where. */
378
+ /** Whether any accessed data was protected by the data masking. */
372
379
  dataMaskingApplied?: boolean;
373
380
  }
374
381
  interface Dataset {
375
- /** [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; */
382
+ /** 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; */
376
383
  access?: Array<{
377
384
  /** [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. */
378
385
  dataset?: DatasetAccessEntry;
@@ -382,7 +389,7 @@ declare namespace gapi.client {
382
389
  groupByEmail?: string;
383
390
  /** [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. */
384
391
  iamMember?: string;
385
- /** [Required] 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". */
392
+ /** 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". */
386
393
  role?: string;
387
394
  /** [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. */
388
395
  routine?: RoutineReference;
@@ -390,61 +397,67 @@ declare namespace gapi.client {
390
397
  specialGroup?: string;
391
398
  /** [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". */
392
399
  userByEmail?: string;
393
- /** [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables 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. */
400
+ /** [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. */
394
401
  view?: TableReference;
395
402
  }>;
396
- /** [Output-only] The time when this dataset was created, in milliseconds since the epoch. */
403
+ /** Output only. The time when this dataset was created, in milliseconds since the epoch. */
397
404
  creationTime?: string;
398
- /** [Required] A reference that identifies the dataset. */
405
+ /** Required. A reference that identifies the dataset. */
399
406
  datasetReference?: DatasetReference;
400
- /** [Output-only] The default collation of the dataset. */
407
+ /** 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. */
401
408
  defaultCollation?: string;
409
+ /** The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. */
402
410
  defaultEncryptionConfiguration?: EncryptionConfiguration;
403
- /** [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. */
411
+ /** 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. */
404
412
  defaultPartitionExpirationMs?: string;
405
- /** [Output-only] The default rounding mode of the dataset. */
413
+ /** 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. */
406
414
  defaultRoundingMode?: string;
407
- /** [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). 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. */
415
+ /** 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. */
408
416
  defaultTableExpirationMs?: string;
409
- /** [Optional] A user-friendly description of the dataset. */
417
+ /** Optional. A user-friendly description of the dataset. */
410
418
  description?: string;
411
- /** [Output-only] A hash of the resource. */
419
+ /** Output only. A hash of the resource. */
412
420
  etag?: string;
413
- /** [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL. */
421
+ /** Optional. Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL. */
414
422
  externalDatasetReference?: ExternalDatasetReference;
415
- /** [Optional] A descriptive name for the dataset. */
423
+ /** Optional. A descriptive name for the dataset. */
416
424
  friendlyName?: string;
417
- /** [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. */
425
+ /** 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. */
418
426
  id?: string;
419
- /** [Optional] Indicates if table names are case insensitive in the dataset. */
427
+ /** 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. */
420
428
  isCaseInsensitive?: boolean;
421
- /** [Output-only] The resource type. */
429
+ /** Output only. The resource type. */
422
430
  kind?: string;
423
431
  /** 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. */
424
432
  labels?: {[P in string]: string};
425
- /** [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch. */
433
+ /** Output only. The date when this dataset was last modified, in milliseconds since the epoch. */
426
434
  lastModifiedTime?: string;
427
- /** The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations. */
435
+ /** 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. */
436
+ linkedDatasetSource?: LinkedDatasetSource;
437
+ /** The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */
428
438
  location?: string;
429
- /** [Optional] Number of hours for the max time travel for all tables in the dataset. */
439
+ /** 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. */
430
440
  maxTimeTravelHours?: string;
431
- /** [Output-only] Reserved for future use. */
441
+ /** Output only. Reserved for future use. */
432
442
  satisfiesPzs?: boolean;
433
- /** [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. */
443
+ /** 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. */
434
444
  selfLink?: string;
435
- /** [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL. */
445
+ /** Optional. Updates storage_billing_model for the dataset. */
436
446
  storageBillingModel?: string;
437
- /** [Optional]The tags associated with this dataset. Tag keys are globally unique. */
447
+ /** Output only. Tags for the Dataset. */
438
448
  tags?: Array<{
439
- /** [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. */
449
+ /** Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. */
440
450
  tagKey?: string;
441
- /** [Required] Friendly short name of the tag value, e.g. "production". */
451
+ /** Required. The friendly short name of the tag value, e.g. "production". */
442
452
  tagValue?: string;
443
453
  }>;
454
+ /** 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_METASTORE - dataset that references a database created in BigLakeMetastore service. -- */
455
+ type?: string;
444
456
  }
445
457
  interface DatasetAccessEntry {
446
- /** [Required] The dataset this entry applies to. */
458
+ /** The dataset this entry applies to */
447
459
  dataset?: DatasetReference;
460
+ /** Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. */
448
461
  targetTypes?: string[];
449
462
  }
450
463
  interface DatasetList {
@@ -452,28 +465,30 @@ declare namespace gapi.client {
452
465
  datasets?: Array<{
453
466
  /** The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID. */
454
467
  datasetReference?: DatasetReference;
455
- /** A descriptive name for the dataset, if one exists. */
468
+ /** An alternate name for the dataset. The friendly name is purely decorative in nature. */
456
469
  friendlyName?: string;
457
470
  /** The fully-qualified, unique, opaque ID of the dataset. */
458
471
  id?: string;
459
- /** The resource type. This property always returns the value "bigquery#dataset". */
472
+ /** The resource type. This property always returns the value "bigquery#dataset" */
460
473
  kind?: string;
461
474
  /** The labels associated with this dataset. You can use these to organize and group your datasets. */
462
475
  labels?: {[P in string]: string};
463
- /** The geographic location where the data resides. */
476
+ /** The geographic location where the dataset resides. */
464
477
  location?: string;
465
478
  }>;
466
- /** A hash value of the results page. You can use this property to determine if the page has changed since the last request. */
479
+ /** 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. */
467
480
  etag?: string;
468
- /** The list type. This property always returns the value "bigquery#datasetList". */
481
+ /** Output only. The resource type. This property always returns the value "bigquery#datasetList" */
469
482
  kind?: string;
470
483
  /** A token that can be used to request the next results page. This property is omitted on the final results page. */
471
484
  nextPageToken?: string;
485
+ /** 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" */
486
+ unreachable?: string[];
472
487
  }
473
488
  interface DatasetReference {
474
- /** [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. */
489
+ /** 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. */
475
490
  datasetId?: string;
476
- /** [Optional] The ID of the project containing this dataset. */
491
+ /** Optional. The ID of the project containing this dataset. */
477
492
  projectId?: string;
478
493
  }
479
494
  interface DataSplitResult {
@@ -485,13 +500,13 @@ declare namespace gapi.client {
485
500
  trainingTable?: TableReference;
486
501
  }
487
502
  interface DestinationTableProperties {
488
- /** [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. */
503
+ /** 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. */
489
504
  description?: string;
490
- /** [Internal] This field is for Google internal use only. */
505
+ /** Internal use only. */
491
506
  expirationTime?: string;
492
- /** [Optional] The friendly name 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 friendly name is provided, the job will fail. */
507
+ /** Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name. */
493
508
  friendlyName?: string;
494
- /** [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. */
509
+ /** 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. */
495
510
  labels?: {[P in string]: string};
496
511
  }
497
512
  interface DimensionalityReductionMetrics {
@@ -499,11 +514,11 @@ declare namespace gapi.client {
499
514
  totalExplainedVarianceRatio?: number;
500
515
  }
501
516
  interface DmlStatistics {
502
- /** Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. */
517
+ /** Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. */
503
518
  deletedRowCount?: string;
504
- /** Number of inserted Rows. Populated by DML INSERT and MERGE statements. */
519
+ /** Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements */
505
520
  insertedRowCount?: string;
506
- /** Number of updated Rows. Populated by DML UPDATE and MERGE statements. */
521
+ /** Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. */
507
522
  updatedRowCount?: string;
508
523
  }
509
524
  interface DoubleCandidates {
@@ -561,6 +576,8 @@ declare namespace gapi.client {
561
576
  interface ExplainQueryStage {
562
577
  /** Number of parallel input segments completed. */
563
578
  completedParallelInputs?: string;
579
+ /** Output only. Compute mode for this stage. */
580
+ computeMode?: string;
564
581
  /** Milliseconds the average shard spent on CPU-bound tasks. */
565
582
  computeMsAvg?: string;
566
583
  /** Milliseconds the slowest shard spent on CPU-bound tasks. */
@@ -569,15 +586,15 @@ declare namespace gapi.client {
569
586
  computeRatioAvg?: number;
570
587
  /** Relative amount of time the slowest shard spent on CPU-bound tasks. */
571
588
  computeRatioMax?: number;
572
- /** Stage end time represented as milliseconds since epoch. */
589
+ /** Stage end time represented as milliseconds since the epoch. */
573
590
  endMs?: string;
574
- /** Unique ID for stage within plan. */
591
+ /** Unique ID for the stage within the plan. */
575
592
  id?: string;
576
593
  /** IDs for stages that are inputs to this stage. */
577
594
  inputStages?: string[];
578
- /** Human-readable name for stage. */
595
+ /** Human-readable name for the stage. */
579
596
  name?: string;
580
- /** Number of parallel input segments to be processed. */
597
+ /** Number of parallel input segments to be processed */
581
598
  parallelInputs?: string;
582
599
  /** Milliseconds the average shard spent reading input. */
583
600
  readMsAvg?: string;
@@ -597,9 +614,9 @@ declare namespace gapi.client {
597
614
  shuffleOutputBytesSpilled?: string;
598
615
  /** Slot-milliseconds used by the stage. */
599
616
  slotMs?: string;
600
- /** Stage start time represented as milliseconds since epoch. */
617
+ /** Stage start time represented as milliseconds since the epoch. */
601
618
  startMs?: string;
602
- /** Current status for the stage. */
619
+ /** Current status for this stage. */
603
620
  status?: string;
604
621
  /** List of operations within the stage in dependency order (approximately chronological). */
605
622
  steps?: ExplainQueryStep[];
@@ -623,7 +640,7 @@ declare namespace gapi.client {
623
640
  interface ExplainQueryStep {
624
641
  /** Machine-readable operation type. */
625
642
  kind?: string;
626
- /** Human-readable stage descriptions. */
643
+ /** Human-readable description of the step(s). */
627
644
  substeps?: string[];
628
645
  }
629
646
  interface Explanation {
@@ -632,6 +649,12 @@ declare namespace gapi.client {
632
649
  /** 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. */
633
650
  featureName?: string;
634
651
  }
652
+ interface ExportDataStatistics {
653
+ /** Number of destination files generated in case of EXPORT DATA statement only. */
654
+ fileCount?: string;
655
+ /** [Alpha] Number of destination rows generated in case of EXPORT DATA statement only. */
656
+ rowCount?: string;
657
+ }
635
658
  interface Expr {
636
659
  /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
637
660
  description?: string;
@@ -645,51 +668,65 @@ declare namespace gapi.client {
645
668
  interface ExternalDataConfiguration {
646
669
  /** Try to detect schema and format options automatically. Any option specified explicitly will be honored. */
647
670
  autodetect?: boolean;
648
- /** Additional properties to set if sourceFormat is set to Avro. */
671
+ /** Optional. Additional properties to set if sourceFormat is set to AVRO. */
649
672
  avroOptions?: AvroOptions;
650
- /** [Optional] Additional options if sourceFormat is set to BIGTABLE. */
673
+ /** Optional. Additional options if sourceFormat is set to BIGTABLE. */
651
674
  bigtableOptions?: BigtableOptions;
652
- /** [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. */
675
+ /** 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. */
653
676
  compression?: string;
654
- /** [Optional, Trusted Tester] Connection for external data source. */
677
+ /** 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>". */
655
678
  connectionId?: string;
656
- /** Additional properties to set if sourceFormat is set to CSV. */
679
+ /** Optional. Additional properties to set if sourceFormat is set to CSV. */
657
680
  csvOptions?: CsvOptions;
658
- /** [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. */
681
+ /** Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. */
659
682
  decimalTargetTypes?: string[];
660
- /** [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. */
683
+ /** 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. */
661
684
  fileSetSpecType?: string;
662
- /** [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. */
685
+ /** Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS. */
663
686
  googleSheetsOptions?: GoogleSheetsOptions;
664
- /** [Optional] Options to configure hive partitioning support. */
687
+ /** 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. */
665
688
  hivePartitioningOptions?: HivePartitioningOptions;
666
- /** [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. */
689
+ /** 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. */
667
690
  ignoreUnknownValues?: boolean;
668
- /** Additional properties to set if `sourceFormat` is set to `NEWLINE_DELIMITED_JSON`. */
691
+ /** 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). */
692
+ jsonExtension?: string;
693
+ /** Optional. Additional properties to set if sourceFormat is set to JSON. */
669
694
  jsonOptions?: JsonOptions;
670
- /** [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. */
695
+ /** 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. */
671
696
  maxBadRecords?: number;
672
- /** [Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source. */
697
+ /** Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source. */
673
698
  metadataCacheMode?: string;
674
- /** 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. */
699
+ /** 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. */
675
700
  objectMetadata?: string;
676
- /** Additional properties to set if sourceFormat is set to Parquet. */
701
+ /** Optional. Additional properties to set if sourceFormat is set to PARQUET. */
677
702
  parquetOptions?: ParquetOptions;
678
- /** [Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC. */
703
+ /** 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. */
679
704
  referenceFileSchemaUri?: string;
680
- /** [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. */
705
+ /** 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. */
681
706
  schema?: TableSchema;
682
- /** [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". */
707
+ /** [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". */
683
708
  sourceFormat?: string;
684
709
  /** [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. */
685
710
  sourceUris?: string[];
686
711
  }
687
712
  interface ExternalDatasetReference {
688
- /** [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} */
713
+ /** Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} */
689
714
  connection?: string;
690
- /** [Required] External source that backs this dataset. */
715
+ /** Required. External source that backs this dataset. */
691
716
  externalSource?: string;
692
717
  }
718
+ interface ExternalServiceCost {
719
+ /** External service cost in terms of bigquery bytes billed. */
720
+ bytesBilled?: string;
721
+ /** External service cost in terms of bigquery bytes processed. */
722
+ bytesProcessed?: string;
723
+ /** External service name. */
724
+ externalService?: string;
725
+ /** 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. */
726
+ reservedSlotCount?: string;
727
+ /** External service cost in terms of bigquery slot milliseconds. */
728
+ slotMs?: string;
729
+ }
693
730
  interface FeatureValue {
694
731
  /** The categorical feature value. */
695
732
  categoricalValue?: CategoricalValue;
@@ -709,7 +746,7 @@ declare namespace gapi.client {
709
746
  interface GetQueryResultsResponse {
710
747
  /** Whether the query result was fetched from the query cache. */
711
748
  cacheHit?: boolean;
712
- /** [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. */
749
+ /** Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages). */
713
750
  errors?: ErrorProto[];
714
751
  /** A hash of this response. */
715
752
  etag?: string;
@@ -719,11 +756,11 @@ declare namespace gapi.client {
719
756
  jobReference?: JobReference;
720
757
  /** The resource type of the response. */
721
758
  kind?: string;
722
- /** [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
759
+ /** Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
723
760
  numDmlAffectedRows?: string;
724
- /** A token used for paging results. */
761
+ /** A token used for paging results. When this token is non-empty, it indicates additional results are available. */
725
762
  pageToken?: string;
726
- /** 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. */
763
+ /** 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. */
727
764
  rows?: TableRow[];
728
765
  /** The schema of the results. Present only when the query completes successfully. */
729
766
  schema?: TableSchema;
@@ -745,19 +782,29 @@ declare namespace gapi.client {
745
782
  explanations?: Explanation[];
746
783
  }
747
784
  interface GoogleSheetsOptions {
748
- /** [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 */
785
+ /** 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 */
749
786
  range?: string;
750
- /** [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */
787
+ /** 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. */
751
788
  skipLeadingRows?: string;
752
789
  }
790
+ interface HighCardinalityJoin {
791
+ /** Output only. Count of left input rows. */
792
+ leftRows?: string;
793
+ /** Output only. Count of the output rows. */
794
+ outputRows?: string;
795
+ /** Output only. Count of right input rows. */
796
+ rightRows?: string;
797
+ /** Output only. The index of the join operator in the ExplainQueryStep lists. */
798
+ stepIndex?: number;
799
+ }
753
800
  interface HivePartitioningOptions {
754
- /** [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. */
801
+ /** 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. */
755
802
  fields?: string[];
756
- /** [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. */
803
+ /** 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. */
757
804
  mode?: string;
758
- /** [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. */
805
+ /** 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. */
759
806
  requirePartitionFilter?: boolean;
760
- /** [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). */
807
+ /** 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. */
761
808
  sourceUriPrefix?: string;
762
809
  }
763
810
  interface HparamSearchSpaces {
@@ -829,15 +876,19 @@ declare namespace gapi.client {
829
876
  trialId?: string;
830
877
  }
831
878
  interface IndexUnusedReason {
832
- /** [Output-only] Specifies the base table involved in the reason that no search index was used. */
879
+ /** Specifies the base table involved in the reason that no search index was used. */
833
880
  baseTable?: TableReference;
834
- /** [Output-only] Specifies the high-level reason for the scenario when no search index was used. */
881
+ /** Specifies the high-level reason for the scenario when no search index was used. */
835
882
  code?: string;
836
- /** [Output-only] Specifies the name of the unused search index, if available. */
883
+ /** Specifies the name of the unused search index, if available. */
837
884
  indexName?: string;
838
- /** [Output-only] Free form human-readable reason for the scenario when no search index was used. */
885
+ /** Free form human-readable reason for the scenario when no search index was used. */
839
886
  message?: string;
840
887
  }
888
+ interface InputDataChange {
889
+ /** Output only. Records read difference percentage compared to a previous run. */
890
+ recordsReadDiffPercentage?: number;
891
+ }
841
892
  interface IntArray {
842
893
  /** Elements in the int array. */
843
894
  elements?: string[];
@@ -863,6 +914,10 @@ declare namespace gapi.client {
863
914
  min?: string;
864
915
  }
865
916
  interface IterationResult {
917
+ /** Arima result. */
918
+ arimaResult?: ArimaResult;
919
+ /** Information about top clusters for clustering models. */
920
+ clusterInfos?: ClusterInfo[];
866
921
  /** Time taken to run the iteration in milliseconds. */
867
922
  durationMs?: string;
868
923
  /** Loss computed on the eval data at the end of iteration. */
@@ -871,29 +926,33 @@ declare namespace gapi.client {
871
926
  index?: number;
872
927
  /** Learn rate used for this iteration. */
873
928
  learnRate?: number;
929
+ /** The information of the principal components. */
930
+ principalComponentInfos?: PrincipalComponentInfo[];
874
931
  /** Loss computed on the training data at the end of iteration. */
875
932
  trainingLoss?: number;
876
933
  }
877
934
  interface Job {
878
- /** [Required] Describes the job configuration. */
935
+ /** Required. Describes the job configuration. */
879
936
  configuration?: JobConfiguration;
880
- /** [Output-only] A hash of this resource. */
937
+ /** Output only. A hash of this resource. */
881
938
  etag?: string;
882
- /** [Output-only] Opaque ID field of the job */
939
+ /** Output only. Opaque ID field of the job. */
883
940
  id?: string;
884
- /** [Output-only] If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. */
885
- jobCreationReason?: any;
886
- /** [Optional] Reference describing the unique-per-user name of the job. */
941
+ /** Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. */
942
+ jobCreationReason?: JobCreationReason;
943
+ /** Optional. Reference describing the unique-per-user name of the job. */
887
944
  jobReference?: JobReference;
888
- /** [Output-only] The type of the resource. */
945
+ /** Output only. The type of the resource. */
889
946
  kind?: string;
890
- /** [Output-only] A URL that can be used to access this resource again. */
947
+ /** 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. */
948
+ principal_subject?: string;
949
+ /** Output only. A URL that can be used to access the resource again. */
891
950
  selfLink?: string;
892
- /** [Output-only] Information about the job, including starting time and ending time of the job. */
951
+ /** Output only. Information about the job, including starting time and ending time of the job. */
893
952
  statistics?: JobStatistics;
894
- /** [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. */
953
+ /** Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. */
895
954
  status?: JobStatus;
896
- /** [Output-only] Email address of the user who ran the job. */
955
+ /** Output only. Email address of the user who ran the job. */
897
956
  user_email?: string;
898
957
  }
899
958
  interface JobCancelResponse {
@@ -905,13 +964,13 @@ declare namespace gapi.client {
905
964
  interface JobConfiguration {
906
965
  /** [Pick one] Copies a table. */
907
966
  copy?: JobConfigurationTableCopy;
908
- /** [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. */
967
+ /** 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. */
909
968
  dryRun?: boolean;
910
969
  /** [Pick one] Configures an extract job. */
911
970
  extract?: JobConfigurationExtract;
912
- /** [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. */
971
+ /** Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. */
913
972
  jobTimeoutMs?: string;
914
- /** [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. */
973
+ /** Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. */
915
974
  jobType?: string;
916
975
  /** 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. */
917
976
  labels?: {[P in string]: string};
@@ -921,165 +980,171 @@ declare namespace gapi.client {
921
980
  query?: JobConfigurationQuery;
922
981
  }
923
982
  interface JobConfigurationExtract {
924
- /** [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models. */
983
+ /** 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. */
925
984
  compression?: string;
926
- /** [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. */
985
+ /** 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. */
927
986
  destinationFormat?: string;
928
987
  /** [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. */
929
988
  destinationUri?: string;
930
989
  /** [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. */
931
990
  destinationUris?: string[];
932
- /** [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. */
991
+ /** 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. */
933
992
  fieldDelimiter?: string;
934
- /** [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models. */
993
+ /** Optional. Model extract options only applicable when extracting models. */
994
+ modelExtractOptions?: ModelExtractOptions;
995
+ /** Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. */
935
996
  printHeader?: boolean;
936
997
  /** A reference to the model being exported. */
937
998
  sourceModel?: ModelReference;
938
999
  /** A reference to the table being exported. */
939
1000
  sourceTable?: TableReference;
940
- /** [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models. */
1001
+ /** Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. */
941
1002
  useAvroLogicalTypes?: boolean;
942
1003
  }
943
1004
  interface JobConfigurationLoad {
944
- /** [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. */
1005
+ /** 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. */
945
1006
  allowJaggedRows?: boolean;
946
1007
  /** Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */
947
1008
  allowQuotedNewlines?: boolean;
948
- /** [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. */
1009
+ /** Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources. */
949
1010
  autodetect?: boolean;
950
- /** [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */
1011
+ /** Clustering specification for the destination table. */
951
1012
  clustering?: Clustering;
952
- /** Connection properties. */
1013
+ /** 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. */
953
1014
  connectionProperties?: ConnectionProperty[];
954
- /** [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. */
1015
+ /** 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. */
955
1016
  createDisposition?: string;
956
- /** If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode. */
1017
+ /** 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. */
957
1018
  createSession?: boolean;
958
- /** [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. */
1019
+ /** Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. */
959
1020
  decimalTargetTypes?: string[];
960
- /** Custom encryption configuration (e.g., Cloud KMS keys). */
1021
+ /** Custom encryption configuration (e.g., Cloud KMS keys) */
961
1022
  destinationEncryptionConfiguration?: EncryptionConfiguration;
962
1023
  /** [Required] The destination table to load the data into. */
963
1024
  destinationTable?: TableReference;
964
- /** [Beta] [Optional] Properties with which to create the destination table if it is new. */
1025
+ /** Optional. [Experimental] Properties with which to create the destination table if it is new. */
965
1026
  destinationTableProperties?: DestinationTableProperties;
966
- /** [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. */
1027
+ /** 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: �. */
967
1028
  encoding?: string;
968
- /** [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */
1029
+ /** 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). */
969
1030
  fieldDelimiter?: string;
970
- /** [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. */
1031
+ /** 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. */
971
1032
  fileSetSpecType?: string;
972
- /** [Optional] Options to configure hive partitioning support. */
1033
+ /** 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. */
973
1034
  hivePartitioningOptions?: HivePartitioningOptions;
974
- /** [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 */
1035
+ /** 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. */
975
1036
  ignoreUnknownValues?: boolean;
976
- /** [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON. */
1037
+ /** 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). */
977
1038
  jsonExtension?: string;
978
- /** [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. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. */
1039
+ /** 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. */
979
1040
  maxBadRecords?: number;
980
- /** [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. */
1041
+ /** 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. */
981
1042
  nullMarker?: string;
982
- /** [Optional] Options to configure parquet support. */
1043
+ /** Optional. Additional properties to set if sourceFormat is set to PARQUET. */
983
1044
  parquetOptions?: ParquetOptions;
984
- /** [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats. */
1045
+ /** 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. */
985
1046
  preserveAsciiControlCharacters?: boolean;
986
1047
  /** 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. */
987
1048
  projectionFields?: string[];
988
- /** [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. */
1049
+ /** 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 " */
989
1050
  quote?: string;
990
- /** [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */
1051
+ /** Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */
991
1052
  rangePartitioning?: RangePartitioning;
992
- /** User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC. */
1053
+ /** 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. */
993
1054
  referenceFileSchemaUri?: string;
994
- /** [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. */
1055
+ /** 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. */
995
1056
  schema?: TableSchema;
996
1057
  /** [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". */
997
1058
  schemaInline?: string;
998
1059
  /** [Deprecated] The format of the schemaInline property. */
999
1060
  schemaInlineFormat?: string;
1000
- /** Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
1061
+ /** Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
1001
1062
  schemaUpdateOptions?: string[];
1002
- /** [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. */
1063
+ /** 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. */
1003
1064
  skipLeadingRows?: number;
1004
- /** [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. */
1065
+ /** 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. */
1005
1066
  sourceFormat?: string;
1006
1067
  /** [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. */
1007
1068
  sourceUris?: string[];
1008
1069
  /** Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */
1009
1070
  timePartitioning?: TimePartitioning;
1010
- /** [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). */
1071
+ /** 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). */
1011
1072
  useAvroLogicalTypes?: boolean;
1012
- /** [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. 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. */
1073
+ /** Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */
1013
1074
  writeDisposition?: string;
1014
1075
  }
1015
1076
  interface JobConfigurationQuery {
1016
- /** [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 standard SQL 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. */
1077
+ /** 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. */
1017
1078
  allowLargeResults?: boolean;
1018
- /** [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */
1079
+ /** Clustering specification for the destination table. */
1019
1080
  clustering?: Clustering;
1020
- /** Connection properties. */
1081
+ /** Connection properties which can modify the query behavior. */
1021
1082
  connectionProperties?: ConnectionProperty[];
1022
1083
  /** [Optional] Specifies whether the query should be executed as a continuous query. The default value is false. */
1023
1084
  continuous?: boolean;
1024
- /** [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. */
1085
+ /** 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. */
1025
1086
  createDisposition?: string;
1026
- /** If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. */
1087
+ /** 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. */
1027
1088
  createSession?: boolean;
1028
- /** [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. */
1089
+ /** 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. */
1029
1090
  defaultDataset?: DatasetReference;
1030
- /** Custom encryption configuration (e.g., Cloud KMS keys). */
1091
+ /** Custom encryption configuration (e.g., Cloud KMS keys) */
1031
1092
  destinationEncryptionConfiguration?: EncryptionConfiguration;
1032
- /** [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size. */
1093
+ /** 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. */
1033
1094
  destinationTable?: TableReference;
1034
- /** [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 standard SQL queries, this flag is ignored and results are never flattened. */
1095
+ /** 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. */
1035
1096
  flattenResults?: boolean;
1036
- /** [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. */
1097
+ /** 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. */
1037
1098
  maximumBillingTier?: number;
1038
- /** [Optional] 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. */
1099
+ /** 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. */
1039
1100
  maximumBytesBilled?: string;
1040
- /** Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */
1101
+ /** GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */
1041
1102
  parameterMode?: string;
1042
1103
  /** [Deprecated] This property is deprecated. */
1043
1104
  preserveNulls?: boolean;
1044
- /** [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. */
1105
+ /** Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. */
1045
1106
  priority?: string;
1046
- /** [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. */
1107
+ /** [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL. */
1047
1108
  query?: string;
1048
- /** Query parameters for standard SQL queries. */
1109
+ /** Query parameters for GoogleSQL queries. */
1049
1110
  queryParameters?: QueryParameter[];
1050
- /** [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */
1111
+ /** Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */
1051
1112
  rangePartitioning?: RangePartitioning;
1052
- /** Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
1113
+ /** Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
1053
1114
  schemaUpdateOptions?: string[];
1054
- /** [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. */
1115
+ /** Options controlling the execution of scripts. */
1116
+ scriptOptions?: ScriptOptions;
1117
+ /** 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. */
1118
+ systemVariables?: SystemVariables;
1119
+ /** 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. */
1055
1120
  tableDefinitions?: {[P in string]: ExternalDataConfiguration};
1056
1121
  /** Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */
1057
1122
  timePartitioning?: TimePartitioning;
1058
- /** Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */
1123
+ /** Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */
1059
1124
  useLegacySql?: boolean;
1060
- /** [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. */
1125
+ /** 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. */
1061
1126
  useQueryCache?: boolean;
1062
1127
  /** Describes user-defined function resources used in the query. */
1063
1128
  userDefinedFunctionResources?: UserDefinedFunctionResource[];
1064
- /** [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 from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */
1129
+ /** Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */
1065
1130
  writeDisposition?: string;
1066
1131
  }
1067
1132
  interface JobConfigurationTableCopy {
1068
- /** [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. */
1133
+ /** 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. */
1069
1134
  createDisposition?: string;
1070
1135
  /** Custom encryption configuration (e.g., Cloud KMS keys). */
1071
1136
  destinationEncryptionConfiguration?: EncryptionConfiguration;
1072
- /** [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. */
1073
- destinationExpirationTime?: any;
1074
- /** [Required] The destination table */
1137
+ /** Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. */
1138
+ destinationExpirationTime?: string;
1139
+ /** [Required] The destination table. */
1075
1140
  destinationTable?: TableReference;
1076
- /** [Optional] Supported operation types in table copy job. */
1141
+ /** Optional. Supported operation types in table copy job. */
1077
1142
  operationType?: string;
1078
1143
  /** [Pick one] Source table to copy. */
1079
1144
  sourceTable?: TableReference;
1080
1145
  /** [Pick one] Source tables to copy. */
1081
1146
  sourceTables?: TableReference[];
1082
- /** [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. 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. */
1147
+ /** 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. */
1083
1148
  writeDisposition?: string;
1084
1149
  }
1085
1150
  interface JobCreationReason {
@@ -1091,21 +1156,23 @@ declare namespace gapi.client {
1091
1156
  etag?: string;
1092
1157
  /** List of jobs that were requested. */
1093
1158
  jobs?: Array<{
1094
- /** [Full-projection-only] Specifies the job configuration. */
1159
+ /** Required. Describes the job configuration. */
1095
1160
  configuration?: JobConfiguration;
1096
1161
  /** A result object that will be present only if the job has failed. */
1097
1162
  errorResult?: ErrorProto;
1098
1163
  /** Unique opaque ID of the job. */
1099
1164
  id?: string;
1100
- /** Job reference uniquely identifying the job. */
1165
+ /** Unique opaque ID of the job. */
1101
1166
  jobReference?: JobReference;
1102
1167
  /** The resource type. */
1103
1168
  kind?: string;
1169
+ /** [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. */
1170
+ principal_subject?: string;
1104
1171
  /** Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed. */
1105
1172
  state?: string;
1106
- /** [Output-only] Information about the job, including starting time and ending time of the job. */
1173
+ /** Output only. Information about the job, including starting time and ending time of the job. */
1107
1174
  statistics?: JobStatistics;
1108
- /** [Full-projection-only] Describes the state of the job. */
1175
+ /** [Full-projection-only] Describes the status of this job. */
1109
1176
  status?: JobStatus;
1110
1177
  /** [Full-projection-only] Email address of the user who ran the job. */
1111
1178
  user_email?: string;
@@ -1114,175 +1181,209 @@ declare namespace gapi.client {
1114
1181
  kind?: string;
1115
1182
  /** A token to request the next page of results. */
1116
1183
  nextPageToken?: string;
1184
+ /** 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" */
1185
+ unreachable?: string[];
1117
1186
  }
1118
1187
  interface JobReference {
1119
- /** [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. */
1188
+ /** 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. */
1120
1189
  jobId?: string;
1121
- /** The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
1190
+ /** 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 */
1122
1191
  location?: string;
1123
- /** [Required] The ID of the project containing this job. */
1192
+ /** Required. The ID of the project containing this job. */
1124
1193
  projectId?: string;
1125
1194
  }
1126
1195
  interface JobStatistics {
1127
- /** [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. */
1196
+ /** Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. */
1128
1197
  completionRatio?: number;
1129
- /** [Output-only] Statistics for a copy job. */
1198
+ /** Output only. Statistics for a copy job. */
1130
1199
  copy?: JobStatistics5;
1131
- /** [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. */
1200
+ /** Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. */
1132
1201
  creationTime?: string;
1133
- /** [Output-only] Statistics for data masking. Present only for query and extract jobs. */
1202
+ /** Output only. Statistics for data-masking. Present only for query and extract jobs. */
1134
1203
  dataMaskingStatistics?: DataMaskingStatistics;
1135
- /** [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. */
1204
+ /** 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. */
1136
1205
  endTime?: string;
1137
- /** [Output-only] Statistics for an extract job. */
1206
+ /** Output only. Statistics for an extract job. */
1138
1207
  extract?: JobStatistics4;
1139
- /** [Output-only] Statistics for a load job. */
1208
+ /** 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. */
1209
+ finalExecutionDurationMs?: string;
1210
+ /** Output only. Statistics for a load job. */
1140
1211
  load?: JobStatistics3;
1141
- /** [Output-only] Number of child jobs executed. */
1212
+ /** Output only. Number of child jobs executed. */
1142
1213
  numChildJobs?: string;
1143
- /** [Output-only] If this is a child job, the id of the parent. */
1214
+ /** Output only. If this is a child job, specifies the job ID of the parent. */
1144
1215
  parentJobId?: string;
1145
- /** [Output-only] Statistics for a query job. */
1216
+ /** Output only. Statistics for a query job. */
1146
1217
  query?: JobStatistics2;
1147
- /** [Output-only] Quotas which delayed this job's start time. */
1218
+ /** Output only. Quotas which delayed this job's start time. */
1148
1219
  quotaDeferments?: string[];
1149
- /** [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. */
1220
+ /** 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. */
1150
1221
  reservation_id?: string;
1151
- /** [Output-only] Job resource usage breakdown by reservation. */
1222
+ /** Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. */
1152
1223
  reservationUsage?: Array<{
1153
- /** [Output-only] Reservation name or "unreserved" for on-demand resources usage. */
1224
+ /** Reservation name or "unreserved" for on-demand resources usage. */
1154
1225
  name?: string;
1155
- /** [Output-only] Slot-milliseconds the job spent in the given reservation. */
1226
+ /** Total slot milliseconds used by the reservation for a particular job. */
1156
1227
  slotMs?: string;
1157
1228
  }>;
1158
- /** [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs. */
1229
+ /** Output only. Statistics for row-level security. Present only for query and extract jobs. */
1159
1230
  rowLevelSecurityStatistics?: RowLevelSecurityStatistics;
1160
- /** [Output-only] Statistics for a child job of a script. */
1231
+ /** Output only. If this a child job of a script, specifies information about the context of this job within the script. */
1161
1232
  scriptStatistics?: ScriptStatistics;
1162
- /** [Output-only] [Preview] Information of the session if this job is part of one. */
1233
+ /** Output only. Information of the session if this job is part of one. */
1163
1234
  sessionInfo?: SessionInfo;
1164
- /** [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. */
1235
+ /** 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. */
1165
1236
  startTime?: string;
1166
- /** [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. */
1237
+ /** Output only. Total bytes processed for the job. */
1167
1238
  totalBytesProcessed?: string;
1168
- /** [Output-only] Slot-milliseconds for the job. */
1239
+ /** Output only. Slot-milliseconds for the job. */
1169
1240
  totalSlotMs?: string;
1170
- /** [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one. */
1241
+ /** 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. */
1171
1242
  transactionInfo?: TransactionInfo;
1172
1243
  }
1173
1244
  interface JobStatistics2 {
1174
- /** BI Engine specific Statistics. [Output only] BI Engine specific Statistics. */
1245
+ /** Output only. BI Engine specific Statistics. */
1175
1246
  biEngineStatistics?: BiEngineStatistics;
1176
- /** [Output only] Billing tier for the job. */
1247
+ /** 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. */
1177
1248
  billingTier?: number;
1178
- /** [Output only] Whether the query result was fetched from the query cache. */
1249
+ /** Output only. Whether the query result was fetched from the query cache. */
1179
1250
  cacheHit?: boolean;
1180
- /** [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. */
1251
+ /** Output only. Referenced dataset for DCL statement. */
1252
+ dclTargetDataset?: DatasetReference;
1253
+ /** Output only. Referenced table for DCL statement. */
1254
+ dclTargetTable?: TableReference;
1255
+ /** Output only. Referenced view for DCL statement. */
1256
+ dclTargetView?: TableReference;
1257
+ /** Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. */
1181
1258
  ddlAffectedRowAccessPolicyCount?: string;
1182
- /** [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. */
1259
+ /** Output only. The table after rename. Present only for ALTER TABLE RENAME TO query. */
1183
1260
  ddlDestinationTable?: TableReference;
1184
- /** The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. */
1261
+ /** Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target. */
1185
1262
  ddlOperationPerformed?: string;
1186
- /** [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries. */
1263
+ /** Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA(dataset) queries. */
1187
1264
  ddlTargetDataset?: DatasetReference;
1188
- /** The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. */
1265
+ /** Output only. [Beta] The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. */
1189
1266
  ddlTargetRoutine?: RoutineReference;
1190
- /** [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. */
1267
+ /** Output only. The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. */
1191
1268
  ddlTargetRowAccessPolicy?: RowAccessPolicyReference;
1192
- /** [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. */
1269
+ /** Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. */
1193
1270
  ddlTargetTable?: TableReference;
1194
- /** [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. */
1271
+ /** Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. */
1195
1272
  dmlStats?: DmlStatistics;
1196
- /** [Output only] The original estimate of bytes processed for the job. */
1273
+ /** Output only. The original estimate of bytes processed for the job. */
1197
1274
  estimatedBytesProcessed?: string;
1198
- /** [Output only] Statistics of a BigQuery ML training job. */
1275
+ /** Output only. Stats for EXPORT DATA statement. */
1276
+ exportDataStatistics?: ExportDataStatistics;
1277
+ /** Output only. Job cost breakdown as bigquery internal cost and external service costs. */
1278
+ externalServiceCosts?: ExternalServiceCost[];
1279
+ /** Output only. Statistics for a LOAD query. */
1280
+ loadQueryStatistics?: LoadQueryStatistics;
1281
+ /** Output only. Statistics of materialized views of a query job. */
1282
+ materializedViewStatistics?: MaterializedViewStatistics;
1283
+ /** Output only. Statistics of metadata cache usage in a query for BigLake tables. */
1284
+ metadataCacheStatistics?: MetadataCacheStatistics;
1285
+ /** Output only. Statistics of a BigQuery ML training job. */
1199
1286
  mlStatistics?: MlStatistics;
1200
- /** [Output only, Beta] Information about create model query job progress. */
1287
+ /** Deprecated. */
1201
1288
  modelTraining?: BigQueryModelTraining;
1202
- /** [Output only, Beta] Deprecated; do not use. */
1289
+ /** Deprecated. */
1203
1290
  modelTrainingCurrentIteration?: number;
1204
- /** [Output only, Beta] Deprecated; do not use. */
1291
+ /** Deprecated. */
1205
1292
  modelTrainingExpectedTotalIteration?: string;
1206
- /** [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
1293
+ /** Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
1207
1294
  numDmlAffectedRows?: string;
1208
- /** [Output only] Describes execution plan for the query. */
1295
+ /** Output only. Performance insights. */
1296
+ performanceInsights?: PerformanceInsights;
1297
+ /** Output only. Query optimization information for a QUERY job. */
1298
+ queryInfo?: QueryInfo;
1299
+ /** Output only. Describes execution plan for the query. */
1209
1300
  queryPlan?: ExplainQueryStage[];
1210
- /** [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job. */
1301
+ /** Output only. Referenced routines for the job. */
1211
1302
  referencedRoutines?: RoutineReference[];
1212
- /** [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. */
1303
+ /** Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. */
1213
1304
  referencedTables?: TableReference[];
1214
- /** [Output only] Job resource usage breakdown by reservation. */
1305
+ /** Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. */
1215
1306
  reservationUsage?: Array<{
1216
- /** [Output only] Reservation name or "unreserved" for on-demand resources usage. */
1307
+ /** Reservation name or "unreserved" for on-demand resources usage. */
1217
1308
  name?: string;
1218
- /** [Output only] Slot-milliseconds the job spent in the given reservation. */
1309
+ /** Total slot milliseconds used by the reservation for a particular job. */
1219
1310
  slotMs?: string;
1220
1311
  }>;
1221
- /** [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */
1312
+ /** Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries. */
1222
1313
  schema?: TableSchema;
1223
- /** [Output only] Search query specific statistics. */
1314
+ /** Output only. Search query specific statistics. */
1224
1315
  searchStatistics?: SearchStatistics;
1225
- /** [Output only] Statistics of a Spark procedure job. */
1316
+ /** Output only. Statistics of a Spark procedure job. */
1226
1317
  sparkStatistics?: SparkStatistics;
1227
- /** The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. */
1318
+ /** Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement. */
1228
1319
  statementType?: string;
1229
- /** [Output only] [Beta] Describes a timeline of job execution. */
1320
+ /** Output only. Describes a timeline of job execution. */
1230
1321
  timeline?: QueryTimelineSample[];
1231
- /** [Output only] Total bytes billed for the job. */
1322
+ /** 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. */
1232
1323
  totalBytesBilled?: string;
1233
- /** [Output only] Total bytes processed for the job. */
1324
+ /** Output only. Total bytes processed for the job. */
1234
1325
  totalBytesProcessed?: string;
1235
- /** [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. */
1326
+ /** 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. */
1236
1327
  totalBytesProcessedAccuracy?: string;
1237
- /** [Output only] Total number of partitions processed from all partitioned tables referenced in the job. */
1328
+ /** Output only. Total number of partitions processed from all partitioned tables referenced in the job. */
1238
1329
  totalPartitionsProcessed?: string;
1239
- /** [Output only] Slot-milliseconds for the job. */
1330
+ /** Output only. Slot-milliseconds for the job. */
1240
1331
  totalSlotMs?: string;
1241
- /** [Output-only] Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). */
1332
+ /** Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). */
1242
1333
  transferredBytes?: string;
1243
- /** Standard SQL only: list of undeclared query parameters detected during a dry run validation. */
1334
+ /** Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. */
1244
1335
  undeclaredQueryParameters?: QueryParameter[];
1336
+ /** Output only. Search query specific statistics. */
1337
+ vectorSearchStatistics?: VectorSearchStatistics;
1245
1338
  }
1246
1339
  interface JobStatistics3 {
1247
- /** [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. */
1340
+ /** 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. */
1248
1341
  badRecords?: string;
1249
- /** [Output-only] Number of bytes of source data in a load job. */
1342
+ /** Output only. Number of bytes of source data in a load job. */
1250
1343
  inputFileBytes?: string;
1251
- /** [Output-only] Number of source files in a load job. */
1344
+ /** Output only. Number of source files in a load job. */
1252
1345
  inputFiles?: string;
1253
- /** [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. */
1346
+ /** Output only. Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. */
1254
1347
  outputBytes?: string;
1255
- /** [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. */
1348
+ /** 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. */
1256
1349
  outputRows?: string;
1350
+ /** Output only. Describes a timeline of job execution. */
1351
+ timeline?: QueryTimelineSample[];
1257
1352
  }
1258
1353
  interface JobStatistics4 {
1259
- /** [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. */
1354
+ /** 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. */
1260
1355
  destinationUriFileCounts?: string[];
1261
- /** [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. */
1356
+ /** 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. */
1262
1357
  inputBytes?: string;
1358
+ /** Output only. Describes a timeline of job execution. */
1359
+ timeline?: QueryTimelineSample[];
1263
1360
  }
1264
1361
  interface JobStatistics5 {
1265
- /** [Output-only] Number of logical bytes copied to the destination table. */
1362
+ /** Output only. Number of logical bytes copied to the destination table. */
1266
1363
  copiedLogicalBytes?: string;
1267
- /** [Output-only] Number of rows copied to the destination table. */
1364
+ /** Output only. Number of rows copied to the destination table. */
1268
1365
  copiedRows?: string;
1269
1366
  }
1270
1367
  interface JobStatus {
1271
- /** [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. */
1368
+ /** Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful. */
1272
1369
  errorResult?: ErrorProto;
1273
- /** [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 completed or was unsuccessful. */
1370
+ /** 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. */
1274
1371
  errors?: ErrorProto[];
1275
- /** [Output-only] Running state of the job. */
1372
+ /** Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'. */
1276
1373
  state?: string;
1277
1374
  }
1278
1375
  interface JsonObject {
1279
1376
  [key: string]: any;
1280
1377
  }
1281
1378
  interface JsonOptions {
1282
- /** [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. */
1379
+ /** 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. */
1283
1380
  encoding?: string;
1284
1381
  }
1285
1382
  interface JsonValue {}
1383
+ interface LinkedDatasetSource {
1384
+ /** The source dataset reference contains project numbers and not project ids. */
1385
+ sourceDataset?: DatasetReference;
1386
+ }
1286
1387
  interface ListModelsResponse {
1287
1388
  /** Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels. */
1288
1389
  models?: Model[];
@@ -1301,29 +1402,73 @@ declare namespace gapi.client {
1301
1402
  /** Row access policies on the requested table. */
1302
1403
  rowAccessPolicies?: RowAccessPolicy[];
1303
1404
  }
1405
+ interface LoadQueryStatistics {
1406
+ /** 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. */
1407
+ badRecords?: string;
1408
+ /** 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. */
1409
+ bytesTransferred?: string;
1410
+ /** Output only. Number of bytes of source data in a LOAD query. */
1411
+ inputFileBytes?: string;
1412
+ /** Output only. Number of source files in a LOAD query. */
1413
+ inputFiles?: string;
1414
+ /** Output only. Size of the loaded data in bytes. Note that while a LOAD query is in the running state, this value may change. */
1415
+ outputBytes?: string;
1416
+ /** 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. */
1417
+ outputRows?: string;
1418
+ }
1304
1419
  interface LocationMetadata {
1305
1420
  /** 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. */
1306
1421
  legacyLocationId?: string;
1307
1422
  }
1423
+ interface MaterializedView {
1424
+ /** 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. */
1425
+ chosen?: boolean;
1426
+ /** If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables. */
1427
+ estimatedBytesSaved?: string;
1428
+ /** If present, specifies the reason why the materialized view was not chosen for the query. */
1429
+ rejectedReason?: string;
1430
+ /** The candidate materialized view. */
1431
+ tableReference?: TableReference;
1432
+ }
1308
1433
  interface MaterializedViewDefinition {
1309
- /** [Optional] Allow non incremental materialized view definition. The default value is "false". */
1434
+ /** Optional. This option declares authors intention to construct a materialized view that will not be refreshed incrementally. */
1310
1435
  allowNonIncrementalDefinition?: boolean;
1311
- /** [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true". */
1436
+ /** Optional. Enable automatic refresh of the materialized view when the base table is updated. The default value is "true". */
1312
1437
  enableRefresh?: boolean;
1313
- /** [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch. */
1438
+ /** Output only. The time when this materialized view was last refreshed, in milliseconds since the epoch. */
1314
1439
  lastRefreshTime?: string;
1315
1440
  /** [Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type). */
1316
1441
  maxStaleness?: string;
1317
- /** [Required] A query whose result is persisted. */
1442
+ /** Required. A query whose results are persisted. */
1318
1443
  query?: string;
1319
- /** [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes). */
1444
+ /** Optional. The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes). */
1320
1445
  refreshIntervalMs?: string;
1321
1446
  }
1447
+ interface MaterializedViewStatistics {
1448
+ /** 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. */
1449
+ materializedView?: MaterializedView[];
1450
+ }
1451
+ interface MaterializedViewStatus {
1452
+ /** Output only. Error result of the last automatic refresh. If present, indicates that the last automatic refresh was unsuccessful. */
1453
+ lastRefreshStatus?: ErrorProto;
1454
+ /** Output only. Refresh watermark of materialized view. The base tables' data were collected into the materialized view cache until this time. */
1455
+ refreshWatermark?: string;
1456
+ }
1457
+ interface MetadataCacheStatistics {
1458
+ /** Set for the Metadata caching eligible tables referenced in the query. */
1459
+ tableMetadataCacheUsage?: TableMetadataCacheUsage[];
1460
+ }
1322
1461
  interface MlStatistics {
1323
- /** Results for all completed iterations. */
1462
+ /** Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id. */
1463
+ hparamTrials?: HparamTuningTrial[];
1464
+ /** Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). */
1324
1465
  iterationResults?: IterationResult[];
1325
- /** 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. */
1466
+ /** 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. */
1326
1467
  maxIterations?: string;
1468
+ /** Output only. The type of the model that is being trained. */
1469
+ modelType?: string;
1470
+ /** Output only. Training type of the job. */
1471
+ trainingType?: string;
1327
1472
  }
1328
1473
  interface Model {
1329
1474
  /** The best trial_id across all training runs. */
@@ -1370,15 +1515,19 @@ declare namespace gapi.client {
1370
1515
  transformColumns?: TransformColumn[];
1371
1516
  }
1372
1517
  interface ModelDefinition {
1373
- /** [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query. */
1518
+ /** Deprecated. */
1374
1519
  modelOptions?: {
1375
1520
  labels?: string[];
1376
1521
  lossType?: string;
1377
1522
  modelType?: string;
1378
1523
  };
1379
- /** [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query. */
1524
+ /** Deprecated. */
1380
1525
  trainingRuns?: BqmlTrainingRun[];
1381
1526
  }
1527
+ interface ModelExtractOptions {
1528
+ /** The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. */
1529
+ trialId?: string;
1530
+ }
1382
1531
  interface ModelReference {
1383
1532
  /** Required. The ID of the dataset containing this model. */
1384
1533
  datasetId?: string;
@@ -1394,11 +1543,19 @@ declare namespace gapi.client {
1394
1543
  confusionMatrixList?: ConfusionMatrix[];
1395
1544
  }
1396
1545
  interface ParquetOptions {
1397
- /** [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. */
1546
+ /** Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. */
1398
1547
  enableListInference?: boolean;
1399
- /** [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. */
1548
+ /** Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. */
1400
1549
  enumAsString?: boolean;
1401
1550
  }
1551
+ interface PerformanceInsights {
1552
+ /** 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. */
1553
+ avgPreviousExecutionMs?: string;
1554
+ /** Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. */
1555
+ stagePerformanceChangeInsights?: StagePerformanceChangeInsight[];
1556
+ /** Output only. Standalone query stage performance insights, for exploring potential improvements. */
1557
+ stagePerformanceStandaloneInsights?: StagePerformanceStandaloneInsight[];
1558
+ }
1402
1559
  interface Policy {
1403
1560
  /** Specifies cloud audit logging configuration for this policy. */
1404
1561
  auditConfigs?: AuditConfig[];
@@ -1424,15 +1581,15 @@ declare namespace gapi.client {
1424
1581
  aggregationThresholdPolicy?: AggregationThresholdPolicy;
1425
1582
  }
1426
1583
  interface ProjectList {
1427
- /** A hash of the page of results */
1584
+ /** A hash of the page of results. */
1428
1585
  etag?: string;
1429
- /** The type of list. */
1586
+ /** The resource type of the response. */
1430
1587
  kind?: string;
1431
- /** A token to request the next page of results. */
1588
+ /** Use this token to request the next page of results. */
1432
1589
  nextPageToken?: string;
1433
- /** Projects to which you have at least READ access. */
1590
+ /** Projects to which the user has at least READ access. */
1434
1591
  projects?: Array<{
1435
- /** A descriptive name for this project. */
1592
+ /** A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string. */
1436
1593
  friendlyName?: string;
1437
1594
  /** An opaque ID of this project. */
1438
1595
  id?: string;
@@ -1443,102 +1600,112 @@ declare namespace gapi.client {
1443
1600
  /** A unique reference to this project. */
1444
1601
  projectReference?: ProjectReference;
1445
1602
  }>;
1446
- /** The total number of projects in the list. */
1603
+ /** 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. */
1447
1604
  totalItems?: number;
1448
1605
  }
1449
1606
  interface ProjectReference {
1450
- /** [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project. */
1607
+ /** Required. ID of the project. Can be either the numeric ID or the assigned ID of the project. */
1451
1608
  projectId?: string;
1452
1609
  }
1610
+ interface QueryInfo {
1611
+ /** Output only. Information about query optimizations. */
1612
+ optimizationDetails?: {[P in string]: any};
1613
+ }
1453
1614
  interface QueryParameter {
1454
- /** [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. */
1615
+ /** Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query. */
1455
1616
  name?: string;
1456
- /** [Required] The type of this parameter. */
1617
+ /** Required. The type of this parameter. */
1457
1618
  parameterType?: QueryParameterType;
1458
- /** [Required] The value of this parameter. */
1619
+ /** Required. The value of this parameter. */
1459
1620
  parameterValue?: QueryParameterValue;
1460
1621
  }
1461
1622
  interface QueryParameterType {
1462
- /** [Optional] The type of the array's elements, if this is an array. */
1623
+ /** Optional. The type of the array's elements, if this is an array. */
1463
1624
  arrayType?: QueryParameterType;
1464
- /** [Optional] The types of the fields of this struct, in order, if this is a struct. */
1625
+ /** Optional. The element type of the range, if this is a range. */
1626
+ rangeElementType?: QueryParameterType;
1627
+ /** Optional. The types of the fields of this struct, in order, if this is a struct. */
1465
1628
  structTypes?: Array<{
1466
- /** [Optional] Human-oriented description of the field. */
1629
+ /** Optional. Human-oriented description of the field. */
1467
1630
  description?: string;
1468
- /** [Optional] The name of this field. */
1631
+ /** Optional. The name of this field. */
1469
1632
  name?: string;
1470
- /** [Required] The type of this field. */
1633
+ /** Required. The type of this field. */
1471
1634
  type?: QueryParameterType;
1472
1635
  }>;
1473
- /** [Required] The top level type of this field. */
1636
+ /** Required. The top level type of this field. */
1474
1637
  type?: string;
1475
1638
  }
1476
1639
  interface QueryParameterValue {
1477
- /** [Optional] The array values, if this is an array type. */
1640
+ /** Optional. The array values, if this is an array type. */
1478
1641
  arrayValues?: QueryParameterValue[];
1479
- /** [Optional] The struct field values, in order of the struct type's declaration. */
1642
+ /** Optional. The range value, if this is a range type. */
1643
+ rangeValue?: RangeValue;
1644
+ /** The struct field values. */
1480
1645
  structValues?: {[P in string]: QueryParameterValue};
1481
- /** [Optional] The value of this value, if a simple scalar type. */
1646
+ /** Optional. The value of this value, if a simple scalar type. */
1482
1647
  value?: string;
1483
1648
  }
1484
1649
  interface QueryRequest {
1485
- /** Connection properties. */
1650
+ /** Optional. Connection properties which can modify the query behavior. */
1486
1651
  connectionProperties?: ConnectionProperty[];
1487
1652
  /** [Optional] Specifies whether the query should be executed as a continuous query. The default value is false. */
1488
1653
  continuous?: boolean;
1489
- /** If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. */
1654
+ /** 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. */
1490
1655
  createSession?: boolean;
1491
- /** [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'. */
1656
+ /** 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'. */
1492
1657
  defaultDataset?: DatasetReference;
1493
- /** [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. */
1658
+ /** 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. */
1494
1659
  dryRun?: boolean;
1660
+ /** Optional. Output format adjustments. */
1661
+ formatOptions?: DataFormatOptions;
1495
1662
  /** Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. This feature is not yet available. Jobs will always be created. */
1496
1663
  jobCreationMode?: string;
1497
1664
  /** The resource type of the request. */
1498
1665
  kind?: string;
1499
- /** 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. */
1666
+ /** 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. */
1500
1667
  labels?: {[P in string]: string};
1501
1668
  /** The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
1502
1669
  location?: string;
1503
- /** [Optional] 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. */
1670
+ /** 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. */
1504
1671
  maximumBytesBilled?: string;
1505
- /** [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. */
1672
+ /** 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. */
1506
1673
  maxResults?: number;
1507
- /** Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */
1674
+ /** GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */
1508
1675
  parameterMode?: string;
1509
- /** [Deprecated] This property is deprecated. */
1676
+ /** This property is deprecated. */
1510
1677
  preserveNulls?: boolean;
1511
- /** [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". */
1678
+ /** Required. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: "SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId". */
1512
1679
  query?: string;
1513
- /** Query parameters for Standard SQL queries. */
1680
+ /** Query parameters for GoogleSQL queries. */
1514
1681
  queryParameters?: QueryParameter[];
1515
- /** 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 the previous request, all parameters in the request that may affect the behavior 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. */
1682
+ /** 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. */
1516
1683
  requestId?: string;
1517
- /** [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds). */
1684
+ /** 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. */
1518
1685
  timeoutMs?: number;
1519
- /** Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */
1686
+ /** Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */
1520
1687
  useLegacySql?: boolean;
1521
- /** [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. */
1688
+ /** 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. */
1522
1689
  useQueryCache?: boolean;
1523
1690
  }
1524
1691
  interface QueryResponse {
1525
1692
  /** Whether the query result was fetched from the query cache. */
1526
1693
  cacheHit?: boolean;
1527
- /** [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. */
1694
+ /** Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. */
1528
1695
  dmlStats?: DmlStatistics;
1529
- /** [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. */
1696
+ /** Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages). */
1530
1697
  errors?: ErrorProto[];
1531
1698
  /** 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. */
1532
1699
  jobComplete?: boolean;
1533
1700
  /** Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. */
1534
- jobCreationReason?: any;
1701
+ jobCreationReason?: JobCreationReason;
1535
1702
  /** 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). */
1536
1703
  jobReference?: JobReference;
1537
1704
  /** The resource type. */
1538
1705
  kind?: string;
1539
- /** [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
1706
+ /** Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
1540
1707
  numDmlAffectedRows?: string;
1541
- /** A token used for paging results. */
1708
+ /** A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results). */
1542
1709
  pageToken?: string;
1543
1710
  /** Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated. */
1544
1711
  queryId?: string;
@@ -1546,7 +1713,7 @@ declare namespace gapi.client {
1546
1713
  rows?: TableRow[];
1547
1714
  /** The schema of the results. Present only when the query completes successfully. */
1548
1715
  schema?: TableSchema;
1549
- /** [Output-only] [Preview] Information of the session if this job is part of one. */
1716
+ /** Output only. Information of the session if this job is part of one. */
1550
1717
  sessionInfo?: SessionInfo;
1551
1718
  /** 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. */
1552
1719
  totalBytesProcessed?: string;
@@ -1554,13 +1721,13 @@ declare namespace gapi.client {
1554
1721
  totalRows?: string;
1555
1722
  }
1556
1723
  interface QueryTimelineSample {
1557
- /** Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. */
1724
+ /** Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. */
1558
1725
  activeUnits?: string;
1559
1726
  /** Total parallel units of work completed by this query. */
1560
1727
  completedUnits?: string;
1561
1728
  /** Milliseconds elapsed since the start of query execution. */
1562
1729
  elapsedMs?: string;
1563
- /** Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots. */
1730
+ /** 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. */
1564
1731
  estimatedRunnableUnits?: string;
1565
1732
  /** Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running. */
1566
1733
  pendingUnits?: string;
@@ -1568,18 +1735,24 @@ declare namespace gapi.client {
1568
1735
  totalSlotMs?: string;
1569
1736
  }
1570
1737
  interface RangePartitioning {
1571
- /** [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. */
1738
+ /** Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. */
1572
1739
  field?: string;
1573
- /** [TrustedTester] [Required] Defines the ranges for range partitioning. */
1740
+ /** [Experimental] Defines the ranges for range partitioning. */
1574
1741
  range?: {
1575
- /** [TrustedTester] [Required] The end of range partitioning, exclusive. */
1742
+ /** [Experimental] The end of range partitioning, exclusive. */
1576
1743
  end?: string;
1577
- /** [TrustedTester] [Required] The width of each interval. */
1744
+ /** [Experimental] The width of each interval. */
1578
1745
  interval?: string;
1579
- /** [TrustedTester] [Required] The start of range partitioning, inclusive. */
1746
+ /** [Experimental] The start of range partitioning, inclusive. */
1580
1747
  start?: string;
1581
1748
  };
1582
1749
  }
1750
+ interface RangeValue {
1751
+ /** Optional. The end value of the range. A missing value represents an unbounded end. */
1752
+ end?: QueryParameterValue;
1753
+ /** Optional. The start value of the range. A missing value represents an unbounded start. */
1754
+ start?: QueryParameterValue;
1755
+ }
1583
1756
  interface RankingMetrics {
1584
1757
  /** Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank. */
1585
1758
  averageRank?: number;
@@ -1661,7 +1834,7 @@ declare namespace gapi.client {
1661
1834
  securityMode?: string;
1662
1835
  /** Optional. Spark specific options. */
1663
1836
  sparkOptions?: SparkOptions;
1664
- /** Optional. Can be set for procedures only. If true (default), the definition body will be validated in the creation and the updates of the procedure. For procedures with an argument of ANY TYPE, the definition body validtion is not supported at creation/update time, and thus this field must be set to false explicitly. */
1837
+ /** 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`. */
1665
1838
  strictMode?: boolean;
1666
1839
  }
1667
1840
  interface RoutineReference {
@@ -1701,37 +1874,45 @@ declare namespace gapi.client {
1701
1874
  tableId?: string;
1702
1875
  }
1703
1876
  interface RowLevelSecurityStatistics {
1704
- /** [Output-only] [Preview] Whether any accessed data was protected by row access policies. */
1877
+ /** Whether any accessed data was protected by row access policies. */
1705
1878
  rowLevelSecurityApplied?: boolean;
1706
1879
  }
1880
+ interface ScriptOptions {
1881
+ /** 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. */
1882
+ keyResultStatement?: string;
1883
+ /** Limit on the number of bytes billed per statement. Exceeding this budget results in an error. */
1884
+ statementByteBudget?: string;
1885
+ /** Timeout period for each statement in a script. */
1886
+ statementTimeoutMs?: string;
1887
+ }
1707
1888
  interface ScriptStackFrame {
1708
- /** [Output-only] One-based end column. */
1889
+ /** Output only. One-based end column. */
1709
1890
  endColumn?: number;
1710
- /** [Output-only] One-based end line. */
1891
+ /** Output only. One-based end line. */
1711
1892
  endLine?: number;
1712
- /** [Output-only] Name of the active procedure, empty if in a top-level script. */
1893
+ /** Output only. Name of the active procedure, empty if in a top-level script. */
1713
1894
  procedureId?: string;
1714
- /** [Output-only] One-based start column. */
1895
+ /** Output only. One-based start column. */
1715
1896
  startColumn?: number;
1716
- /** [Output-only] One-based start line. */
1897
+ /** Output only. One-based start line. */
1717
1898
  startLine?: number;
1718
- /** [Output-only] Text of the current statement/expression. */
1899
+ /** Output only. Text of the current statement/expression. */
1719
1900
  text?: string;
1720
1901
  }
1721
1902
  interface ScriptStatistics {
1722
- /** [Output-only] Whether this child job was a statement or expression. */
1903
+ /** Whether this child job was a statement or expression. */
1723
1904
  evaluationKind?: string;
1724
1905
  /** 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. */
1725
1906
  stackFrames?: ScriptStackFrame[];
1726
1907
  }
1727
1908
  interface SearchStatistics {
1728
- /** When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated. */
1909
+ /** 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. */
1729
1910
  indexUnusedReasons?: IndexUnusedReason[];
1730
- /** Specifies index usage mode for the query. */
1911
+ /** Specifies the index usage mode for the query. */
1731
1912
  indexUsageMode?: string;
1732
1913
  }
1733
1914
  interface SessionInfo {
1734
- /** [Output-only] // [Preview] Id of the session. */
1915
+ /** Output only. The id of the session. */
1735
1916
  sessionId?: string;
1736
1917
  }
1737
1918
  interface SetIamPolicyRequest {
@@ -1741,15 +1922,15 @@ declare namespace gapi.client {
1741
1922
  updateMask?: string;
1742
1923
  }
1743
1924
  interface SnapshotDefinition {
1744
- /** [Required] Reference describing the ID of the table that was snapshot. */
1925
+ /** Required. Reference describing the ID of the table that was snapshot. */
1745
1926
  baseTableReference?: TableReference;
1746
- /** [Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format. */
1927
+ /** Required. The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format. */
1747
1928
  snapshotTime?: string;
1748
1929
  }
1749
1930
  interface SparkLoggingInfo {
1750
- /** [Output-only] Project ID used for logging */
1931
+ /** Output only. Project ID where the Spark logs were written. */
1751
1932
  projectId?: string;
1752
- /** [Output-only] Resource type used for logging */
1933
+ /** Output only. Resource type used for logging. */
1753
1934
  resourceType?: string;
1754
1935
  }
1755
1936
  interface SparkOptions {
@@ -1775,15 +1956,37 @@ declare namespace gapi.client {
1775
1956
  runtimeVersion?: string;
1776
1957
  }
1777
1958
  interface SparkStatistics {
1778
- /** [Output-only] Endpoints generated for the Spark job. */
1959
+ /** Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI. */
1779
1960
  endpoints?: {[P in string]: string};
1780
- /** [Output-only] Logging info is used to generate a link to Cloud Logging. */
1961
+ /** Output only. The Google Cloud Storage bucket that is used as the default filesystem by the Spark application. This fields is only filled when the Spark procedure uses the INVOKER security mode. It is inferred from the system variable @@spark_proc_properties.staging_bucket 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]` */
1962
+ gcsStagingBucket?: string;
1963
+ /** Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses DEFINER security mode, the Cloud KMS key is inferred from the Spark connection associated with the procedure if it is provided. Otherwise the key is inferred from the default key of the Spark connection's project if the CMEK organization policy is enforced. If the Spark procedure uses INVOKER security mode, the Cloud KMS encryption key is inferred from the system variable @@spark_proc_properties.kms_key_name if it is provided. Otherwise, the key is inferred fromt he default key of the BigQuery job's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` */
1964
+ kmsKeyName?: string;
1965
+ /** Output only. Logging info is used to generate a link to Cloud Logging. */
1781
1966
  loggingInfo?: SparkLoggingInfo;
1782
- /** [Output-only] Spark job id if a Spark job is created successfully. */
1967
+ /** Output only. Spark job ID if a Spark job is created successfully. */
1783
1968
  sparkJobId?: string;
1784
- /** [Output-only] Location where the Spark job is executed. */
1969
+ /** Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. */
1785
1970
  sparkJobLocation?: string;
1786
1971
  }
1972
+ interface StagePerformanceChangeInsight {
1973
+ /** Output only. Input data change insight of the query stage. */
1974
+ inputDataChange?: InputDataChange;
1975
+ /** Output only. The stage id that the insight mapped to. */
1976
+ stageId?: string;
1977
+ }
1978
+ interface StagePerformanceStandaloneInsight {
1979
+ /** Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution. */
1980
+ biEngineReasons?: BiEngineReason[];
1981
+ /** Output only. High cardinality joins in the stage. */
1982
+ highCardinalityJoins?: HighCardinalityJoin[];
1983
+ /** Output only. True if the stage has insufficient shuffle quota. */
1984
+ insufficientShuffleQuota?: boolean;
1985
+ /** Output only. True if the stage has a slot contention issue. */
1986
+ slotContention?: boolean;
1987
+ /** Output only. The stage id that the insight mapped to. */
1988
+ stageId?: string;
1989
+ }
1787
1990
  interface StandardSqlDataType {
1788
1991
  /** The type of the array's elements, if type_kind = "ARRAY". */
1789
1992
  arrayElementType?: StandardSqlDataType;
@@ -1809,117 +2012,133 @@ declare namespace gapi.client {
1809
2012
  columns?: StandardSqlField[];
1810
2013
  }
1811
2014
  interface Streamingbuffer {
1812
- /** [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer. */
2015
+ /** Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer. */
1813
2016
  estimatedBytes?: string;
1814
- /** [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer. */
2017
+ /** Output only. A lower-bound estimate of the number of rows currently in the streaming buffer. */
1815
2018
  estimatedRows?: string;
1816
- /** [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available. */
2019
+ /** Output only. Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available. */
1817
2020
  oldestEntryTime?: string;
1818
2021
  }
1819
2022
  interface StringHparamSearchSpace {
1820
2023
  /** Canididates for the string or enum parameter in lower case. */
1821
2024
  candidates?: string[];
1822
2025
  }
2026
+ interface SystemVariables {
2027
+ /** Output only. Data type for each system variable. */
2028
+ types?: {[P in string]: StandardSqlDataType};
2029
+ /** Output only. Value for each system variable. */
2030
+ values?: {[P in string]: any};
2031
+ }
1823
2032
  interface Table {
1824
- /** [Optional] Specifies the configuration of a BigLake managed table. */
2033
+ /** Optional. Specifies the configuration of a BigLake managed table. */
1825
2034
  biglakeConfiguration?: BigLakeConfiguration;
1826
- /** [Output-only] Clone definition. */
2035
+ /** Output only. Contains information about the clone. This value is set via the clone operation. */
1827
2036
  cloneDefinition?: CloneDefinition;
1828
- /** [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered. */
2037
+ /** Clustering specification for the table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */
1829
2038
  clustering?: Clustering;
1830
- /** [Output-only] The time when this table was created, in milliseconds since the epoch. */
2039
+ /** Output only. The time when this table was created, in milliseconds since the epoch. */
1831
2040
  creationTime?: string;
1832
- /** [Output-only] The default collation of the table. */
2041
+ /** 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. */
1833
2042
  defaultCollation?: string;
1834
- /** [Output-only] The default rounding mode of the table. */
2043
+ /** 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. */
1835
2044
  defaultRoundingMode?: string;
1836
- /** [Optional] A user-friendly description of this table. */
2045
+ /** Optional. A user-friendly description of this table. */
1837
2046
  description?: string;
1838
2047
  /** Custom encryption configuration (e.g., Cloud KMS keys). */
1839
2048
  encryptionConfiguration?: EncryptionConfiguration;
1840
- /** [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change. */
2049
+ /** Output only. A hash of this resource. */
1841
2050
  etag?: string;
1842
- /** [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. */
2051
+ /** 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. */
1843
2052
  expirationTime?: string;
1844
- /** [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. */
2053
+ /** 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. */
1845
2054
  externalDataConfiguration?: ExternalDataConfiguration;
1846
- /** [Optional] A descriptive name for this table. */
2055
+ /** Optional. A descriptive name for this table. */
1847
2056
  friendlyName?: string;
1848
- /** [Output-only] An opaque ID uniquely identifying the table. */
2057
+ /** Output only. An opaque ID uniquely identifying the table. */
1849
2058
  id?: string;
1850
- /** [Output-only] The type of the resource. */
2059
+ /** The type of resource ID. */
1851
2060
  kind?: string;
1852
2061
  /** 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. */
1853
2062
  labels?: {[P in string]: string};
1854
- /** [Output-only] The time when this table was last modified, in milliseconds since the epoch. */
2063
+ /** Output only. The time when this table was last modified, in milliseconds since the epoch. */
1855
2064
  lastModifiedTime?: string;
1856
- /** [Output-only] The geographic location where the table resides. This value is inherited from the dataset. */
2065
+ /** Output only. The geographic location where the table resides. This value is inherited from the dataset. */
1857
2066
  location?: string;
1858
- /** [Optional] Materialized view definition. */
2067
+ /** Optional. The materialized view definition. */
1859
2068
  materializedView?: MaterializedViewDefinition;
1860
- /** [Optional] Max staleness of data that could be returned when table or materialized view is queried (formatted as Google SQL Interval type). */
2069
+ /** Output only. The materialized view status. */
2070
+ materializedViewStatus?: MaterializedViewStatus;
2071
+ /** 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. */
1861
2072
  maxStaleness?: string;
1862
- /** [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries. */
2073
+ /** Deprecated. */
1863
2074
  model?: ModelDefinition;
1864
- /** [Output-only] Number of logical bytes that are less than 90 days old. */
2075
+ /** Output only. Number of logical bytes that are less than 90 days old. */
1865
2076
  numActiveLogicalBytes?: string;
1866
- /** [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. */
2077
+ /** 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. */
1867
2078
  numActivePhysicalBytes?: string;
1868
- /** [Output-only] The size of this table in bytes, excluding any data in the streaming buffer. */
2079
+ /** Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. */
1869
2080
  numBytes?: string;
1870
- /** [Output-only] The number of bytes in the table that are considered "long-term storage". */
2081
+ /** Output only. The number of logical bytes in the table that are considered "long-term storage". */
1871
2082
  numLongTermBytes?: string;
1872
- /** [Output-only] Number of logical bytes that are more than 90 days old. */
2083
+ /** Output only. Number of logical bytes that are more than 90 days old. */
1873
2084
  numLongTermLogicalBytes?: string;
1874
- /** [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. */
2085
+ /** 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. */
1875
2086
  numLongTermPhysicalBytes?: string;
1876
- /** [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. */
2087
+ /** 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. */
1877
2088
  numPartitions?: string;
1878
- /** [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel. */
2089
+ /** Output only. The physical size of this table in bytes. This includes storage used for time travel. */
1879
2090
  numPhysicalBytes?: string;
1880
- /** [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer. */
2091
+ /** Output only. The number of rows of data in this table, excluding any data in the streaming buffer. */
1881
2092
  numRows?: string;
1882
- /** [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. */
2093
+ /** 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. */
1883
2094
  numTimeTravelPhysicalBytes?: string;
1884
- /** [Output-only] Total number of logical bytes in the table or materialized view. */
2095
+ /** Output only. Total number of logical bytes in the table or materialized view. */
1885
2096
  numTotalLogicalBytes?: string;
1886
- /** [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. */
2097
+ /** 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. */
1887
2098
  numTotalPhysicalBytes?: string;
1888
- /** [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */
2099
+ /** If specified, configures range partitioning for this table. */
1889
2100
  rangePartitioning?: RangePartitioning;
1890
- /** [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. */
2101
+ /** Optional. Output only. Table references of all replicas currently active on the table. */
2102
+ replicas?: TableReference[];
2103
+ /** Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. */
1891
2104
  requirePartitionFilter?: boolean;
1892
2105
  /** [Optional] The tags associated with this table. Tag keys are globally unique. See additional information on [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). 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". */
1893
2106
  resourceTags?: {[P in string]: string};
1894
- /** [Optional] Describes the schema of this table. */
2107
+ /** Optional. Describes the schema of this table. */
1895
2108
  schema?: TableSchema;
1896
- /** [Output-only] A URL that can be used to access this resource again. */
2109
+ /** Output only. A URL that can be used to access this resource again. */
1897
2110
  selfLink?: string;
1898
- /** [Output-only] Snapshot definition. */
2111
+ /** Output only. Contains information about the snapshot. This value is set via snapshot creation. */
1899
2112
  snapshotDefinition?: SnapshotDefinition;
1900
- /** [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. */
2113
+ /** 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. */
1901
2114
  streamingBuffer?: Streamingbuffer;
1902
- /** [Optional] The table constraints on the table. */
2115
+ /** Optional. Tables Primary Key and Foreign Key information */
1903
2116
  tableConstraints?: TableConstraints;
1904
- /** [Required] Reference describing the ID of this table. */
2117
+ /** Required. Reference describing the ID of this table. */
1905
2118
  tableReference?: TableReference;
1906
- /** Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */
2119
+ /** Optional. Table replication info for table created `AS REPLICA` DDL like: `CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv` */
2120
+ tableReplicationInfo?: TableReplicationInfo;
2121
+ /** If specified, configures time-based partitioning for this table. */
1907
2122
  timePartitioning?: TimePartitioning;
1908
- /** [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. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. */
2123
+ /** 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](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. */
1909
2124
  type?: string;
1910
- /** [Optional] The view definition. */
2125
+ /** Optional. The view definition. */
1911
2126
  view?: ViewDefinition;
1912
2127
  }
1913
2128
  interface TableCell {
1914
2129
  v?: any;
1915
2130
  }
1916
2131
  interface TableConstraints {
1917
- /** [Optional] The foreign keys of the tables. */
2132
+ /** Optional. Present only if the table has a foreign key. The foreign key is not enforced. */
1918
2133
  foreignKeys?: Array<{
2134
+ /** Required. The columns that compose the foreign key. */
1919
2135
  columnReferences?: Array<{
2136
+ /** Required. The column in the primary key that are referenced by the referencing_column. */
1920
2137
  referencedColumn?: string;
2138
+ /** Required. The column that composes the foreign key. */
1921
2139
  referencingColumn?: string;
1922
2140
  }>;
2141
+ /** Optional. Set only if the foreign key constraint is named. */
1923
2142
  name?: string;
1924
2143
  referencedTable?: {
1925
2144
  datasetId?: string;
@@ -1927,37 +2146,39 @@ declare namespace gapi.client {
1927
2146
  tableId?: string;
1928
2147
  };
1929
2148
  }>;
1930
- /** [Optional] The primary key of the table. */
2149
+ /** Represents the primary key constraint on a table's columns. */
1931
2150
  primaryKey?: {
2151
+ /** Required. The columns that are composed of the primary key constraint. */
1932
2152
  columns?: string[];
1933
2153
  };
1934
2154
  }
1935
2155
  interface TableDataInsertAllRequest {
1936
- /** [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. */
2156
+ /** 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. */
1937
2157
  ignoreUnknownValues?: boolean;
1938
- /** The resource type of the response. */
2158
+ /** 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. */
1939
2159
  kind?: string;
1940
- /** The rows to insert. */
1941
2160
  rows?: Array<{
1942
- /** [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis. */
2161
+ /** 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. */
1943
2162
  insertId?: string;
1944
- /** [Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema. */
2163
+ /** Data for a single row. */
1945
2164
  json?: JsonObject;
1946
2165
  }>;
1947
- /** [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. */
2166
+ /** 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. */
1948
2167
  skipInvalidRows?: boolean;
1949
- /** 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. */
2168
+ /** 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. */
1950
2169
  templateSuffix?: string;
2170
+ /** 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. */
2171
+ traceId?: string;
1951
2172
  }
1952
2173
  interface TableDataInsertAllResponse {
1953
- /** An array of errors for rows that were not inserted. */
2174
+ /** Describes specific errors encountered while processing the request. */
1954
2175
  insertErrors?: Array<{
1955
2176
  /** Error information for the row indicated by the index property. */
1956
2177
  errors?: ErrorProto[];
1957
2178
  /** The index of the row that error applies to. */
1958
2179
  index?: number;
1959
2180
  }>;
1960
- /** The resource type of the response. */
2181
+ /** Returns "bigquery#tableDataInsertAllResponse". */
1961
2182
  kind?: string;
1962
2183
  }
1963
2184
  interface TableDataList {
@@ -1969,45 +2190,46 @@ declare namespace gapi.client {
1969
2190
  pageToken?: string;
1970
2191
  /** Rows of results. */
1971
2192
  rows?: TableRow[];
1972
- /** The total number of rows in the complete table. */
2193
+ /** Total rows of the entire table. In order to show default value 0 we have to present it as string. */
1973
2194
  totalRows?: string;
1974
2195
  }
1975
2196
  interface TableFieldSchema {
1976
- /** [Optional] The categories attached to this field, used for field-level access control. */
2197
+ /** Deprecated. */
1977
2198
  categories?: {
1978
- /** A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. */
2199
+ /** Deprecated. */
1979
2200
  names?: string[];
1980
2201
  };
1981
- /** Optional. Collation specification of the field. It only can be set on string type field. */
2202
+ /** 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. */
1982
2203
  collation?: string;
1983
- /** Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01'] */
2204
+ /** Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. */
1984
2205
  defaultValueExpression?: string;
1985
- /** [Optional] The field description. The maximum length is 1,024 characters. */
2206
+ /** Optional. The field description. The maximum length is 1,024 characters. */
1986
2207
  description?: string;
1987
- /** [Optional] Describes the nested schema fields if the type property is set to RECORD. */
2208
+ /** Optional. Describes the nested schema fields if the type property is set to RECORD. */
1988
2209
  fields?: TableFieldSchema[];
1989
- /** [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". */
2210
+ /** 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". */
1990
2211
  maxLength?: string;
1991
- /** [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. */
2212
+ /** Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. */
1992
2213
  mode?: string;
1993
- /** [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. */
2214
+ /** 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. */
1994
2215
  name?: string;
2216
+ /** Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags. */
1995
2217
  policyTags?: {
1996
- /** A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. */
2218
+ /** 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. */
1997
2219
  names?: string[];
1998
2220
  };
1999
- /** [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. */
2221
+ /** 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. */
2000
2222
  precision?: string;
2001
- /** Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP */
2223
+ /** Represents the type of a field element. */
2002
2224
  rangeElementType?: {
2003
- /** The field element type of a RANGE */
2225
+ /** Required. The type of a field element. See TableFieldSchema.type. */
2004
2226
  type?: string;
2005
2227
  };
2006
- /** Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields. */
2228
+ /** Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. */
2007
2229
  roundingMode?: string;
2008
- /** [Optional] See documentation for precision. */
2230
+ /** Optional. See documentation for precision. */
2009
2231
  scale?: string;
2010
- /** [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). */
2232
+ /** 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) Use of RECORD/STRUCT indicates that the field contains a nested schema. */
2011
2233
  type?: string;
2012
2234
  }
2013
2235
  interface TableList {
@@ -2019,45 +2241,71 @@ declare namespace gapi.client {
2019
2241
  nextPageToken?: string;
2020
2242
  /** Tables in the requested dataset. */
2021
2243
  tables?: Array<{
2022
- /** [Beta] Clustering specification for this table, if configured. */
2244
+ /** Clustering specification for this table, if configured. */
2023
2245
  clustering?: Clustering;
2024
- /** The time when this table was created, in milliseconds since the epoch. */
2246
+ /** Output only. The time when this table was created, in milliseconds since the epoch. */
2025
2247
  creationTime?: string;
2026
- /** [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. */
2248
+ /** 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. */
2027
2249
  expirationTime?: string;
2028
2250
  /** The user-friendly name for this table. */
2029
2251
  friendlyName?: string;
2030
- /** An opaque ID of the table */
2252
+ /** An opaque ID of the table. */
2031
2253
  id?: string;
2032
2254
  /** The resource type. */
2033
2255
  kind?: string;
2034
2256
  /** The labels associated with this table. You can use these to organize and group your tables. */
2035
2257
  labels?: {[P in string]: string};
2036
- /** The range partitioning specification for this table, if configured. */
2258
+ /** The range partitioning for this table. */
2037
2259
  rangePartitioning?: RangePartitioning;
2038
- /** A reference uniquely identifying the table. */
2260
+ /** Optional. If set to true, queries including this table must specify a partition filter. This filter is used for partition elimination. */
2261
+ requirePartitionFilter?: boolean;
2262
+ /** A reference uniquely identifying table. */
2039
2263
  tableReference?: TableReference;
2040
- /** The time-based partitioning specification for this table, if configured. */
2264
+ /** The time-based partitioning for this table. */
2041
2265
  timePartitioning?: TimePartitioning;
2042
- /** The type of table. Possible values are: TABLE, VIEW. */
2266
+ /** The type of table. */
2043
2267
  type?: string;
2044
- /** Additional details for a view. */
2268
+ /** Information about a logical view. */
2045
2269
  view?: {
2046
- /** True if view is defined in legacy SQL dialect, false if in standard SQL. */
2270
+ /** Specifices the privacy policy for the view. */
2271
+ privacyPolicy?: PrivacyPolicy;
2272
+ /** True if view is defined in legacy SQL dialect, false if in GoogleSQL. */
2047
2273
  useLegacySql?: boolean;
2048
2274
  };
2049
2275
  }>;
2050
2276
  /** The total number of tables in the dataset. */
2051
2277
  totalItems?: number;
2052
2278
  }
2279
+ interface TableMetadataCacheUsage {
2280
+ /** Free form human-readable reason metadata caching was unused for the job. */
2281
+ explanation?: string;
2282
+ /** Metadata caching eligible table referenced in the query. */
2283
+ tableReference?: TableReference;
2284
+ /** [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type). */
2285
+ tableType?: string;
2286
+ /** Reason for not using metadata caching for the table. */
2287
+ unusedReason?: string;
2288
+ }
2053
2289
  interface TableReference {
2054
- /** [Required] The ID of the dataset containing this table. */
2290
+ /** Required. The ID of the dataset containing this table. */
2055
2291
  datasetId?: string;
2056
- /** [Required] The ID of the project containing this table. */
2292
+ /** Required. The ID of the project containing this table. */
2057
2293
  projectId?: string;
2058
- /** [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */
2294
+ /** Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. */
2059
2295
  tableId?: string;
2060
2296
  }
2297
+ interface TableReplicationInfo {
2298
+ /** Optional. Output only. If source is a materialized view, this field signifies the last refresh time of the source. */
2299
+ replicatedSourceLastRefreshTime?: string;
2300
+ /** Optional. Output only. Replication error that will permanently stopped table replication. */
2301
+ replicationError?: ErrorProto;
2302
+ /** Required. Specifies the interval at which the source table is polled for updates. */
2303
+ replicationIntervalMs?: string;
2304
+ /** Optional. Output only. Replication status of configured replication. */
2305
+ replicationStatus?: string;
2306
+ /** Required. Source table reference that is replicated. */
2307
+ sourceTable?: TableReference;
2308
+ }
2061
2309
  interface TableRow {
2062
2310
  /** Represents a single row in the result set, consisting of one or more fields. */
2063
2311
  f?: TableCell[];
@@ -2075,12 +2323,13 @@ declare namespace gapi.client {
2075
2323
  permissions?: string[];
2076
2324
  }
2077
2325
  interface TimePartitioning {
2078
- /** [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. */
2326
+ /** Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. */
2079
2327
  expirationMs?: string;
2080
- /** [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. */
2328
+ /** 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. */
2081
2329
  field?: string;
2330
+ /** 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. */
2082
2331
  requirePartitionFilter?: boolean;
2083
- /** [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. */
2332
+ /** Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. */
2084
2333
  type?: string;
2085
2334
  }
2086
2335
  interface TrainingOptions {
@@ -2280,7 +2529,7 @@ declare namespace gapi.client {
2280
2529
  vertexAiModelVersion?: string;
2281
2530
  }
2282
2531
  interface TransactionInfo {
2283
- /** [Output-only] // [Alpha] Id of the transaction. */
2532
+ /** Output only. [Alpha] Id of the transaction. */
2284
2533
  transactionId?: string;
2285
2534
  }
2286
2535
  interface TransformColumn {
@@ -2291,6 +2540,10 @@ declare namespace gapi.client {
2291
2540
  /** Output only. Data type of the column after the transform. */
2292
2541
  type?: StandardSqlDataType;
2293
2542
  }
2543
+ interface UndeleteDatasetRequest {
2544
+ /** Optional. The exact time when the dataset was deleted. If not specified, it will undelete the most recently deleted version. */
2545
+ deletionTime?: string;
2546
+ }
2294
2547
  interface UserDefinedFunctionResource {
2295
2548
  /** [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. */
2296
2549
  inlineCode?: string;
@@ -2304,11 +2557,13 @@ declare namespace gapi.client {
2304
2557
  indexUsageMode?: string;
2305
2558
  }
2306
2559
  interface ViewDefinition {
2307
- /** [Required] A query that BigQuery executes when the view is referenced. */
2560
+ /** Optional. Specifices the privacy policy for the view. */
2561
+ privacyPolicy?: PrivacyPolicy;
2562
+ /** Required. A query that BigQuery executes when the view is referenced. */
2308
2563
  query?: string;
2309
- /** True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1, c2) AS ...' syntax. Can only be set using BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ */
2564
+ /** 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. */
2310
2565
  useExplicitColumnNames?: boolean;
2311
- /** Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value. */
2566
+ /** Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value. A wrapper is used here because the default value is True. */
2312
2567
  useLegacySql?: boolean;
2313
2568
  /** Describes user-defined function resources used in the query. */
2314
2569
  userDefinedFunctionResources?: UserDefinedFunctionResource[];
@@ -2316,9 +2571,15 @@ declare namespace gapi.client {
2316
2571
  interface DatasetsResource {
2317
2572
  /** Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. */
2318
2573
  delete(request?: {
2319
- /** Data format for the response. */
2574
+ /** V1 error format. */
2575
+ '$.xgafv'?: string;
2576
+ /** OAuth access token. */
2577
+ access_token?: string;
2578
+ /** Data format for response. */
2320
2579
  alt?: string;
2321
- /** Dataset ID of dataset being deleted */
2580
+ /** JSONP */
2581
+ callback?: string;
2582
+ /** Required. Dataset ID of dataset being deleted */
2322
2583
  datasetId: string;
2323
2584
  /** If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False */
2324
2585
  deleteContents?: boolean;
@@ -2330,20 +2591,28 @@ declare namespace gapi.client {
2330
2591
  oauth_token?: string;
2331
2592
  /** Returns response with indentations and line breaks. */
2332
2593
  prettyPrint?: boolean;
2333
- /** Project ID of the dataset being deleted */
2594
+ /** Required. Project ID of the dataset being deleted */
2334
2595
  projectId: string;
2335
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2596
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2336
2597
  quotaUser?: string;
2337
- /** Deprecated. Please use quotaUser instead. */
2338
- userIp?: string;
2598
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2599
+ upload_protocol?: string;
2600
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2601
+ uploadType?: string;
2339
2602
  }): Request<void>;
2340
2603
  /** Returns the dataset specified by datasetID. */
2341
2604
  get(request?: {
2342
- /** Data format for the response. */
2605
+ /** V1 error format. */
2606
+ '$.xgafv'?: string;
2607
+ /** OAuth access token. */
2608
+ access_token?: string;
2609
+ /** Data format for response. */
2343
2610
  alt?: string;
2344
- /** Dataset ID of the requested dataset */
2611
+ /** JSONP */
2612
+ callback?: string;
2613
+ /** Required. Dataset ID of the requested dataset */
2345
2614
  datasetId: string;
2346
- /** Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned. Allowed values: METADATA, ACL, FULL. */
2615
+ /** Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned. */
2347
2616
  datasetView?: string;
2348
2617
  /** Selector specifying which fields to include in a partial response. */
2349
2618
  fields?: string;
@@ -2353,17 +2622,25 @@ declare namespace gapi.client {
2353
2622
  oauth_token?: string;
2354
2623
  /** Returns response with indentations and line breaks. */
2355
2624
  prettyPrint?: boolean;
2356
- /** Project ID of the requested dataset */
2625
+ /** Required. Project ID of the requested dataset */
2357
2626
  projectId: string;
2358
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2627
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2359
2628
  quotaUser?: string;
2360
- /** Deprecated. Please use quotaUser instead. */
2361
- userIp?: string;
2629
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2630
+ upload_protocol?: string;
2631
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2632
+ uploadType?: string;
2362
2633
  }): Request<Dataset>;
2363
2634
  /** Creates a new empty dataset. */
2364
2635
  insert(request: {
2365
- /** Data format for the response. */
2636
+ /** V1 error format. */
2637
+ '$.xgafv'?: string;
2638
+ /** OAuth access token. */
2639
+ access_token?: string;
2640
+ /** Data format for response. */
2366
2641
  alt?: string;
2642
+ /** JSONP */
2643
+ callback?: string;
2367
2644
  /** Selector specifying which fields to include in a partial response. */
2368
2645
  fields?: string;
2369
2646
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2372,19 +2649,27 @@ declare namespace gapi.client {
2372
2649
  oauth_token?: string;
2373
2650
  /** Returns response with indentations and line breaks. */
2374
2651
  prettyPrint?: boolean;
2375
- /** Project ID of the new dataset */
2652
+ /** Required. Project ID of the new dataset */
2376
2653
  projectId: string;
2377
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2654
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2378
2655
  quotaUser?: string;
2379
- /** Deprecated. Please use quotaUser instead. */
2380
- userIp?: string;
2656
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2657
+ upload_protocol?: string;
2658
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2659
+ uploadType?: string;
2381
2660
  /** Request body */
2382
2661
  resource: Dataset;
2383
2662
  }): Request<Dataset>;
2384
2663
  insert(
2385
2664
  request: {
2386
- /** Data format for the response. */
2665
+ /** V1 error format. */
2666
+ '$.xgafv'?: string;
2667
+ /** OAuth access token. */
2668
+ access_token?: string;
2669
+ /** Data format for response. */
2387
2670
  alt?: string;
2671
+ /** JSONP */
2672
+ callback?: string;
2388
2673
  /** Selector specifying which fields to include in a partial response. */
2389
2674
  fields?: string;
2390
2675
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2393,28 +2678,36 @@ declare namespace gapi.client {
2393
2678
  oauth_token?: string;
2394
2679
  /** Returns response with indentations and line breaks. */
2395
2680
  prettyPrint?: boolean;
2396
- /** Project ID of the new dataset */
2681
+ /** Required. Project ID of the new dataset */
2397
2682
  projectId: string;
2398
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2683
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2399
2684
  quotaUser?: string;
2400
- /** Deprecated. Please use quotaUser instead. */
2401
- userIp?: string;
2685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2686
+ upload_protocol?: string;
2687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2688
+ uploadType?: string;
2402
2689
  },
2403
2690
  body: Dataset
2404
2691
  ): Request<Dataset>;
2405
- /** Lists all datasets in the specified project to which you have been granted the READER dataset role. */
2692
+ /** Lists all datasets in the specified project to which the user has been granted the READER dataset role. */
2406
2693
  list(request?: {
2694
+ /** V1 error format. */
2695
+ '$.xgafv'?: string;
2696
+ /** OAuth access token. */
2697
+ access_token?: string;
2407
2698
  /** Whether to list all datasets, including hidden ones */
2408
2699
  all?: boolean;
2409
- /** Data format for the response. */
2700
+ /** Data format for response. */
2410
2701
  alt?: string;
2702
+ /** JSONP */
2703
+ callback?: string;
2411
2704
  /** Selector specifying which fields to include in a partial response. */
2412
2705
  fields?: string;
2413
- /** An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details. */
2706
+ /** An expression for filtering the results of the request by label. The syntax is \"labels.<name>[:<value>]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See [Filtering datasets using labels](/bigquery/docs/labeling-datasets#filtering_datasets_using_labels) for details. */
2414
2707
  filter?: string;
2415
2708
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2416
2709
  key?: string;
2417
- /** The maximum number of results to return */
2710
+ /** The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. */
2418
2711
  maxResults?: number;
2419
2712
  /** OAuth 2.0 token for the current user. */
2420
2713
  oauth_token?: string;
@@ -2422,18 +2715,26 @@ declare namespace gapi.client {
2422
2715
  pageToken?: string;
2423
2716
  /** Returns response with indentations and line breaks. */
2424
2717
  prettyPrint?: boolean;
2425
- /** Project ID of the datasets to be listed */
2718
+ /** Required. Project ID of the datasets to be listed */
2426
2719
  projectId: string;
2427
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2720
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2428
2721
  quotaUser?: string;
2429
- /** Deprecated. Please use quotaUser instead. */
2430
- userIp?: string;
2722
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2723
+ upload_protocol?: string;
2724
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2725
+ uploadType?: string;
2431
2726
  }): Request<DatasetList>;
2432
- /** Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. */
2727
+ /** Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics. */
2433
2728
  patch(request: {
2434
- /** Data format for the response. */
2729
+ /** V1 error format. */
2730
+ '$.xgafv'?: string;
2731
+ /** OAuth access token. */
2732
+ access_token?: string;
2733
+ /** Data format for response. */
2435
2734
  alt?: string;
2436
- /** Dataset ID of the dataset being updated */
2735
+ /** JSONP */
2736
+ callback?: string;
2737
+ /** Required. Dataset ID of the dataset being updated */
2437
2738
  datasetId: string;
2438
2739
  /** Selector specifying which fields to include in a partial response. */
2439
2740
  fields?: string;
@@ -2443,20 +2744,28 @@ declare namespace gapi.client {
2443
2744
  oauth_token?: string;
2444
2745
  /** Returns response with indentations and line breaks. */
2445
2746
  prettyPrint?: boolean;
2446
- /** Project ID of the dataset being updated */
2747
+ /** Required. Project ID of the dataset being updated */
2447
2748
  projectId: string;
2448
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2749
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2449
2750
  quotaUser?: string;
2450
- /** Deprecated. Please use quotaUser instead. */
2451
- userIp?: string;
2751
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2752
+ upload_protocol?: string;
2753
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2754
+ uploadType?: string;
2452
2755
  /** Request body */
2453
2756
  resource: Dataset;
2454
2757
  }): Request<Dataset>;
2455
2758
  patch(
2456
2759
  request: {
2457
- /** Data format for the response. */
2760
+ /** V1 error format. */
2761
+ '$.xgafv'?: string;
2762
+ /** OAuth access token. */
2763
+ access_token?: string;
2764
+ /** Data format for response. */
2458
2765
  alt?: string;
2459
- /** Dataset ID of the dataset being updated */
2766
+ /** JSONP */
2767
+ callback?: string;
2768
+ /** Required. Dataset ID of the dataset being updated */
2460
2769
  datasetId: string;
2461
2770
  /** Selector specifying which fields to include in a partial response. */
2462
2771
  fields?: string;
@@ -2466,20 +2775,90 @@ declare namespace gapi.client {
2466
2775
  oauth_token?: string;
2467
2776
  /** Returns response with indentations and line breaks. */
2468
2777
  prettyPrint?: boolean;
2469
- /** Project ID of the dataset being updated */
2778
+ /** Required. Project ID of the dataset being updated */
2470
2779
  projectId: string;
2471
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2780
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2472
2781
  quotaUser?: string;
2473
- /** Deprecated. Please use quotaUser instead. */
2474
- userIp?: string;
2782
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2783
+ upload_protocol?: string;
2784
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2785
+ uploadType?: string;
2475
2786
  },
2476
2787
  body: Dataset
2477
2788
  ): Request<Dataset>;
2789
+ /** Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted. */
2790
+ undelete(request: {
2791
+ /** V1 error format. */
2792
+ '$.xgafv'?: string;
2793
+ /** OAuth access token. */
2794
+ access_token?: string;
2795
+ /** Data format for response. */
2796
+ alt?: string;
2797
+ /** JSONP */
2798
+ callback?: string;
2799
+ /** Required. Dataset ID of dataset being deleted */
2800
+ datasetId: string;
2801
+ /** Selector specifying which fields to include in a partial response. */
2802
+ fields?: string;
2803
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2804
+ key?: string;
2805
+ /** OAuth 2.0 token for the current user. */
2806
+ oauth_token?: string;
2807
+ /** Returns response with indentations and line breaks. */
2808
+ prettyPrint?: boolean;
2809
+ /** Required. Project ID of the dataset to be undeleted */
2810
+ projectId: string;
2811
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2812
+ quotaUser?: string;
2813
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2814
+ upload_protocol?: string;
2815
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2816
+ uploadType?: string;
2817
+ /** Request body */
2818
+ resource: UndeleteDatasetRequest;
2819
+ }): Request<Dataset>;
2820
+ undelete(
2821
+ request: {
2822
+ /** V1 error format. */
2823
+ '$.xgafv'?: string;
2824
+ /** OAuth access token. */
2825
+ access_token?: string;
2826
+ /** Data format for response. */
2827
+ alt?: string;
2828
+ /** JSONP */
2829
+ callback?: string;
2830
+ /** Required. Dataset ID of dataset being deleted */
2831
+ datasetId: string;
2832
+ /** Selector specifying which fields to include in a partial response. */
2833
+ fields?: string;
2834
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2835
+ key?: string;
2836
+ /** OAuth 2.0 token for the current user. */
2837
+ oauth_token?: string;
2838
+ /** Returns response with indentations and line breaks. */
2839
+ prettyPrint?: boolean;
2840
+ /** Required. Project ID of the dataset to be undeleted */
2841
+ projectId: string;
2842
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2843
+ quotaUser?: string;
2844
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2845
+ upload_protocol?: string;
2846
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2847
+ uploadType?: string;
2848
+ },
2849
+ body: UndeleteDatasetRequest
2850
+ ): Request<Dataset>;
2478
2851
  /** Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. */
2479
2852
  update(request: {
2480
- /** Data format for the response. */
2853
+ /** V1 error format. */
2854
+ '$.xgafv'?: string;
2855
+ /** OAuth access token. */
2856
+ access_token?: string;
2857
+ /** Data format for response. */
2481
2858
  alt?: string;
2482
- /** Dataset ID of the dataset being updated */
2859
+ /** JSONP */
2860
+ callback?: string;
2861
+ /** Required. Dataset ID of the dataset being updated */
2483
2862
  datasetId: string;
2484
2863
  /** Selector specifying which fields to include in a partial response. */
2485
2864
  fields?: string;
@@ -2489,20 +2868,28 @@ declare namespace gapi.client {
2489
2868
  oauth_token?: string;
2490
2869
  /** Returns response with indentations and line breaks. */
2491
2870
  prettyPrint?: boolean;
2492
- /** Project ID of the dataset being updated */
2871
+ /** Required. Project ID of the dataset being updated */
2493
2872
  projectId: string;
2494
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2873
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2495
2874
  quotaUser?: string;
2496
- /** Deprecated. Please use quotaUser instead. */
2497
- userIp?: string;
2875
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2876
+ upload_protocol?: string;
2877
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2878
+ uploadType?: string;
2498
2879
  /** Request body */
2499
2880
  resource: Dataset;
2500
2881
  }): Request<Dataset>;
2501
2882
  update(
2502
2883
  request: {
2503
- /** Data format for the response. */
2884
+ /** V1 error format. */
2885
+ '$.xgafv'?: string;
2886
+ /** OAuth access token. */
2887
+ access_token?: string;
2888
+ /** Data format for response. */
2504
2889
  alt?: string;
2505
- /** Dataset ID of the dataset being updated */
2890
+ /** JSONP */
2891
+ callback?: string;
2892
+ /** Required. Dataset ID of the dataset being updated */
2506
2893
  datasetId: string;
2507
2894
  /** Selector specifying which fields to include in a partial response. */
2508
2895
  fields?: string;
@@ -2512,12 +2899,14 @@ declare namespace gapi.client {
2512
2899
  oauth_token?: string;
2513
2900
  /** Returns response with indentations and line breaks. */
2514
2901
  prettyPrint?: boolean;
2515
- /** Project ID of the dataset being updated */
2902
+ /** Required. Project ID of the dataset being updated */
2516
2903
  projectId: string;
2517
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2904
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2518
2905
  quotaUser?: string;
2519
- /** Deprecated. Please use quotaUser instead. */
2520
- userIp?: string;
2906
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2907
+ upload_protocol?: string;
2908
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2909
+ uploadType?: string;
2521
2910
  },
2522
2911
  body: Dataset
2523
2912
  ): Request<Dataset>;
@@ -2525,31 +2914,45 @@ declare namespace gapi.client {
2525
2914
  interface JobsResource {
2526
2915
  /** Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. */
2527
2916
  cancel(request?: {
2528
- /** Data format for the response. */
2917
+ /** V1 error format. */
2918
+ '$.xgafv'?: string;
2919
+ /** OAuth access token. */
2920
+ access_token?: string;
2921
+ /** Data format for response. */
2529
2922
  alt?: string;
2923
+ /** JSONP */
2924
+ callback?: string;
2530
2925
  /** Selector specifying which fields to include in a partial response. */
2531
2926
  fields?: string;
2532
- /** [Required] Job ID of the job to cancel */
2927
+ /** Required. Job ID of the job to cancel */
2533
2928
  jobId: string;
2534
2929
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2535
2930
  key?: string;
2536
- /** The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
2931
+ /** The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
2537
2932
  location?: string;
2538
2933
  /** OAuth 2.0 token for the current user. */
2539
2934
  oauth_token?: string;
2540
2935
  /** Returns response with indentations and line breaks. */
2541
2936
  prettyPrint?: boolean;
2542
- /** [Required] Project ID of the job to cancel */
2937
+ /** Required. Project ID of the job to cancel */
2543
2938
  projectId: string;
2544
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2939
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2545
2940
  quotaUser?: string;
2546
- /** Deprecated. Please use quotaUser instead. */
2547
- userIp?: string;
2941
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2942
+ upload_protocol?: string;
2943
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2944
+ uploadType?: string;
2548
2945
  }): Request<JobCancelResponse>;
2549
2946
  /** Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted. */
2550
2947
  delete(request?: {
2551
- /** Data format for the response. */
2948
+ /** V1 error format. */
2949
+ '$.xgafv'?: string;
2950
+ /** OAuth access token. */
2951
+ access_token?: string;
2952
+ /** Data format for response. */
2552
2953
  alt?: string;
2954
+ /** JSONP */
2955
+ callback?: string;
2553
2956
  /** Selector specifying which fields to include in a partial response. */
2554
2957
  fields?: string;
2555
2958
  /** Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed. */
@@ -2564,69 +2967,95 @@ declare namespace gapi.client {
2564
2967
  prettyPrint?: boolean;
2565
2968
  /** Required. Project ID of the job for which metadata is to be deleted. */
2566
2969
  projectId: string;
2567
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
2970
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2568
2971
  quotaUser?: string;
2569
- /** Deprecated. Please use quotaUser instead. */
2570
- userIp?: string;
2972
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2973
+ upload_protocol?: string;
2974
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2975
+ uploadType?: string;
2571
2976
  }): Request<void>;
2572
2977
  /** Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. */
2573
2978
  get(request?: {
2574
- /** Data format for the response. */
2979
+ /** V1 error format. */
2980
+ '$.xgafv'?: string;
2981
+ /** OAuth access token. */
2982
+ access_token?: string;
2983
+ /** Data format for response. */
2575
2984
  alt?: string;
2985
+ /** JSONP */
2986
+ callback?: string;
2576
2987
  /** Selector specifying which fields to include in a partial response. */
2577
2988
  fields?: string;
2578
- /** [Required] Job ID of the requested job */
2989
+ /** Required. Job ID of the requested job. */
2579
2990
  jobId: string;
2580
2991
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2581
2992
  key?: string;
2582
- /** The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
2993
+ /** The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
2583
2994
  location?: string;
2584
2995
  /** OAuth 2.0 token for the current user. */
2585
2996
  oauth_token?: string;
2586
2997
  /** Returns response with indentations and line breaks. */
2587
2998
  prettyPrint?: boolean;
2588
- /** [Required] Project ID of the requested job */
2999
+ /** Required. Project ID of the requested job. */
2589
3000
  projectId: string;
2590
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3001
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2591
3002
  quotaUser?: string;
2592
- /** Deprecated. Please use quotaUser instead. */
2593
- userIp?: string;
3003
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3004
+ upload_protocol?: string;
3005
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3006
+ uploadType?: string;
2594
3007
  }): Request<Job>;
2595
- /** Retrieves the results of a query job. */
3008
+ /** RPC to get the results of a query job. */
2596
3009
  getQueryResults(request?: {
2597
- /** Data format for the response. */
3010
+ /** V1 error format. */
3011
+ '$.xgafv'?: string;
3012
+ /** OAuth access token. */
3013
+ access_token?: string;
3014
+ /** Data format for response. */
2598
3015
  alt?: string;
3016
+ /** JSONP */
3017
+ callback?: string;
2599
3018
  /** Selector specifying which fields to include in a partial response. */
2600
3019
  fields?: string;
2601
- /** [Required] Job ID of the query job */
3020
+ /** Optional. Output timestamp as usec int64. Default is false. */
3021
+ 'formatOptions.useInt64Timestamp'?: boolean;
3022
+ /** Required. Job ID of the query job. */
2602
3023
  jobId: string;
2603
3024
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2604
3025
  key?: string;
2605
- /** The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
3026
+ /** The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */
2606
3027
  location?: string;
2607
- /** Maximum number of results to read */
3028
+ /** Maximum number of results to read. */
2608
3029
  maxResults?: number;
2609
3030
  /** OAuth 2.0 token for the current user. */
2610
3031
  oauth_token?: string;
2611
- /** Page token, returned by a previous call, to request the next page of results */
3032
+ /** Page token, returned by a previous call, to request the next page of results. */
2612
3033
  pageToken?: string;
2613
3034
  /** Returns response with indentations and line breaks. */
2614
3035
  prettyPrint?: boolean;
2615
- /** [Required] Project ID of the query job */
3036
+ /** Required. Project ID of the query job. */
2616
3037
  projectId: string;
2617
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3038
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2618
3039
  quotaUser?: string;
2619
- /** Zero-based index of the starting row */
3040
+ /** Zero-based index of the starting row. */
2620
3041
  startIndex?: string;
2621
- /** How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false */
3042
+ /** 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. */
2622
3043
  timeoutMs?: number;
2623
- /** Deprecated. Please use quotaUser instead. */
2624
- userIp?: string;
3044
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3045
+ upload_protocol?: string;
3046
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3047
+ uploadType?: string;
2625
3048
  }): Request<GetQueryResultsResponse>;
2626
- /** Starts a new asynchronous job. Requires the Can View project role. */
3049
+ /** Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts. */
2627
3050
  insert(request: {
2628
- /** Data format for the response. */
3051
+ /** V1 error format. */
3052
+ '$.xgafv'?: string;
3053
+ /** OAuth access token. */
3054
+ access_token?: string;
3055
+ /** Data format for response. */
2629
3056
  alt?: string;
3057
+ /** JSONP */
3058
+ callback?: string;
2630
3059
  /** Selector specifying which fields to include in a partial response. */
2631
3060
  fields?: string;
2632
3061
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2635,19 +3064,27 @@ declare namespace gapi.client {
2635
3064
  oauth_token?: string;
2636
3065
  /** Returns response with indentations and line breaks. */
2637
3066
  prettyPrint?: boolean;
2638
- /** Project ID of the project that will be billed for the job */
3067
+ /** Project ID of project that will be billed for the job. */
2639
3068
  projectId: string;
2640
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3069
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2641
3070
  quotaUser?: string;
2642
- /** Deprecated. Please use quotaUser instead. */
2643
- userIp?: string;
3071
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3072
+ upload_protocol?: string;
3073
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3074
+ uploadType?: string;
2644
3075
  /** Request body */
2645
3076
  resource: Job;
2646
3077
  }): Request<Job>;
2647
3078
  insert(
2648
3079
  request: {
2649
- /** Data format for the response. */
3080
+ /** V1 error format. */
3081
+ '$.xgafv'?: string;
3082
+ /** OAuth access token. */
3083
+ access_token?: string;
3084
+ /** Data format for response. */
2650
3085
  alt?: string;
3086
+ /** JSONP */
3087
+ callback?: string;
2651
3088
  /** Selector specifying which fields to include in a partial response. */
2652
3089
  fields?: string;
2653
3090
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2656,54 +3093,70 @@ declare namespace gapi.client {
2656
3093
  oauth_token?: string;
2657
3094
  /** Returns response with indentations and line breaks. */
2658
3095
  prettyPrint?: boolean;
2659
- /** Project ID of the project that will be billed for the job */
3096
+ /** Project ID of project that will be billed for the job. */
2660
3097
  projectId: string;
2661
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3098
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2662
3099
  quotaUser?: string;
2663
- /** Deprecated. Please use quotaUser instead. */
2664
- userIp?: string;
3100
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3101
+ upload_protocol?: string;
3102
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3103
+ uploadType?: string;
2665
3104
  },
2666
3105
  body: Job
2667
3106
  ): Request<Job>;
2668
3107
  /** Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. */
2669
3108
  list(request?: {
2670
- /** Whether to display jobs owned by all users in the project. Default false */
3109
+ /** V1 error format. */
3110
+ '$.xgafv'?: string;
3111
+ /** OAuth access token. */
3112
+ access_token?: string;
3113
+ /** Whether to display jobs owned by all users in the project. Default False. */
2671
3114
  allUsers?: boolean;
2672
- /** Data format for the response. */
3115
+ /** Data format for response. */
2673
3116
  alt?: string;
3117
+ /** JSONP */
3118
+ callback?: string;
2674
3119
  /** Selector specifying which fields to include in a partial response. */
2675
3120
  fields?: string;
2676
3121
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2677
3122
  key?: string;
2678
- /** Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned */
3123
+ /** Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned. */
2679
3124
  maxCreationTime?: string;
2680
- /** Maximum number of results to return */
3125
+ /** The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. */
2681
3126
  maxResults?: number;
2682
- /** Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned */
3127
+ /** Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned. */
2683
3128
  minCreationTime?: string;
2684
3129
  /** OAuth 2.0 token for the current user. */
2685
3130
  oauth_token?: string;
2686
- /** Page token, returned by a previous call, to request the next page of results */
3131
+ /** Page token, returned by a previous call, to request the next page of results. */
2687
3132
  pageToken?: string;
2688
- /** If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent */
3133
+ /** If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs. */
2689
3134
  parentJobId?: string;
2690
3135
  /** Returns response with indentations and line breaks. */
2691
3136
  prettyPrint?: boolean;
2692
- /** Project ID of the jobs to list */
3137
+ /** Project ID of the jobs to list. */
2693
3138
  projectId: string;
2694
3139
  /** Restrict information returned to a set of selected fields */
2695
3140
  projection?: string;
2696
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3141
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2697
3142
  quotaUser?: string;
2698
3143
  /** Filter for job state */
2699
3144
  stateFilter?: string | string[];
2700
- /** Deprecated. Please use quotaUser instead. */
2701
- userIp?: string;
3145
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3146
+ upload_protocol?: string;
3147
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3148
+ uploadType?: string;
2702
3149
  }): Request<JobList>;
2703
3150
  /** Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. */
2704
3151
  query(request: {
2705
- /** Data format for the response. */
3152
+ /** V1 error format. */
3153
+ '$.xgafv'?: string;
3154
+ /** OAuth access token. */
3155
+ access_token?: string;
3156
+ /** Data format for response. */
2706
3157
  alt?: string;
3158
+ /** JSONP */
3159
+ callback?: string;
2707
3160
  /** Selector specifying which fields to include in a partial response. */
2708
3161
  fields?: string;
2709
3162
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2712,19 +3165,27 @@ declare namespace gapi.client {
2712
3165
  oauth_token?: string;
2713
3166
  /** Returns response with indentations and line breaks. */
2714
3167
  prettyPrint?: boolean;
2715
- /** Project ID of the project billed for the query */
3168
+ /** Required. Project ID of the query request. */
2716
3169
  projectId: string;
2717
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3170
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2718
3171
  quotaUser?: string;
2719
- /** Deprecated. Please use quotaUser instead. */
2720
- userIp?: string;
3172
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3173
+ upload_protocol?: string;
3174
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3175
+ uploadType?: string;
2721
3176
  /** Request body */
2722
3177
  resource: QueryRequest;
2723
3178
  }): Request<QueryResponse>;
2724
3179
  query(
2725
3180
  request: {
2726
- /** Data format for the response. */
3181
+ /** V1 error format. */
3182
+ '$.xgafv'?: string;
3183
+ /** OAuth access token. */
3184
+ access_token?: string;
3185
+ /** Data format for response. */
2727
3186
  alt?: string;
3187
+ /** JSONP */
3188
+ callback?: string;
2728
3189
  /** Selector specifying which fields to include in a partial response. */
2729
3190
  fields?: string;
2730
3191
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2733,12 +3194,14 @@ declare namespace gapi.client {
2733
3194
  oauth_token?: string;
2734
3195
  /** Returns response with indentations and line breaks. */
2735
3196
  prettyPrint?: boolean;
2736
- /** Project ID of the project billed for the query */
3197
+ /** Required. Project ID of the query request. */
2737
3198
  projectId: string;
2738
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3199
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2739
3200
  quotaUser?: string;
2740
- /** Deprecated. Please use quotaUser instead. */
2741
- userIp?: string;
3201
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3202
+ upload_protocol?: string;
3203
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3204
+ uploadType?: string;
2742
3205
  },
2743
3206
  body: QueryRequest
2744
3207
  ): Request<QueryResponse>;
@@ -2746,8 +3209,14 @@ declare namespace gapi.client {
2746
3209
  interface ModelsResource {
2747
3210
  /** Deletes the model specified by modelId from the dataset. */
2748
3211
  delete(request?: {
2749
- /** Data format for the response. */
3212
+ /** V1 error format. */
3213
+ '$.xgafv'?: string;
3214
+ /** OAuth access token. */
3215
+ access_token?: string;
3216
+ /** Data format for response. */
2750
3217
  alt?: string;
3218
+ /** JSONP */
3219
+ callback?: string;
2751
3220
  /** Required. Dataset ID of the model to delete. */
2752
3221
  datasetId: string;
2753
3222
  /** Selector specifying which fields to include in a partial response. */
@@ -2762,15 +3231,23 @@ declare namespace gapi.client {
2762
3231
  prettyPrint?: boolean;
2763
3232
  /** Required. Project ID of the model to delete. */
2764
3233
  projectId: string;
2765
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3234
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2766
3235
  quotaUser?: string;
2767
- /** Deprecated. Please use quotaUser instead. */
2768
- userIp?: string;
3236
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3237
+ upload_protocol?: string;
3238
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3239
+ uploadType?: string;
2769
3240
  }): Request<void>;
2770
3241
  /** Gets the specified model resource by model ID. */
2771
3242
  get(request?: {
2772
- /** Data format for the response. */
3243
+ /** V1 error format. */
3244
+ '$.xgafv'?: string;
3245
+ /** OAuth access token. */
3246
+ access_token?: string;
3247
+ /** Data format for response. */
2773
3248
  alt?: string;
3249
+ /** JSONP */
3250
+ callback?: string;
2774
3251
  /** Required. Dataset ID of the requested model. */
2775
3252
  datasetId: string;
2776
3253
  /** Selector specifying which fields to include in a partial response. */
@@ -2785,15 +3262,23 @@ declare namespace gapi.client {
2785
3262
  prettyPrint?: boolean;
2786
3263
  /** Required. Project ID of the requested model. */
2787
3264
  projectId: string;
2788
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3265
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2789
3266
  quotaUser?: string;
2790
- /** Deprecated. Please use quotaUser instead. */
2791
- userIp?: string;
3267
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3268
+ upload_protocol?: string;
3269
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3270
+ uploadType?: string;
2792
3271
  }): Request<Model>;
2793
3272
  /** Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. */
2794
3273
  list(request?: {
2795
- /** Data format for the response. */
3274
+ /** V1 error format. */
3275
+ '$.xgafv'?: string;
3276
+ /** OAuth access token. */
3277
+ access_token?: string;
3278
+ /** Data format for response. */
2796
3279
  alt?: string;
3280
+ /** JSONP */
3281
+ callback?: string;
2797
3282
  /** Required. Dataset ID of the models to list. */
2798
3283
  datasetId: string;
2799
3284
  /** Selector specifying which fields to include in a partial response. */
@@ -2810,15 +3295,23 @@ declare namespace gapi.client {
2810
3295
  prettyPrint?: boolean;
2811
3296
  /** Required. Project ID of the models to list. */
2812
3297
  projectId: string;
2813
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3298
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2814
3299
  quotaUser?: string;
2815
- /** Deprecated. Please use quotaUser instead. */
2816
- userIp?: string;
3300
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3301
+ upload_protocol?: string;
3302
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3303
+ uploadType?: string;
2817
3304
  }): Request<ListModelsResponse>;
2818
3305
  /** Patch specific fields in the specified model. */
2819
3306
  patch(request: {
2820
- /** Data format for the response. */
3307
+ /** V1 error format. */
3308
+ '$.xgafv'?: string;
3309
+ /** OAuth access token. */
3310
+ access_token?: string;
3311
+ /** Data format for response. */
2821
3312
  alt?: string;
3313
+ /** JSONP */
3314
+ callback?: string;
2822
3315
  /** Required. Dataset ID of the model to patch. */
2823
3316
  datasetId: string;
2824
3317
  /** Selector specifying which fields to include in a partial response. */
@@ -2833,17 +3326,25 @@ declare namespace gapi.client {
2833
3326
  prettyPrint?: boolean;
2834
3327
  /** Required. Project ID of the model to patch. */
2835
3328
  projectId: string;
2836
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3329
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2837
3330
  quotaUser?: string;
2838
- /** Deprecated. Please use quotaUser instead. */
2839
- userIp?: string;
3331
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3332
+ upload_protocol?: string;
3333
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3334
+ uploadType?: string;
2840
3335
  /** Request body */
2841
3336
  resource: Model;
2842
3337
  }): Request<Model>;
2843
3338
  patch(
2844
3339
  request: {
2845
- /** Data format for the response. */
3340
+ /** V1 error format. */
3341
+ '$.xgafv'?: string;
3342
+ /** OAuth access token. */
3343
+ access_token?: string;
3344
+ /** Data format for response. */
2846
3345
  alt?: string;
3346
+ /** JSONP */
3347
+ callback?: string;
2847
3348
  /** Required. Dataset ID of the model to patch. */
2848
3349
  datasetId: string;
2849
3350
  /** Selector specifying which fields to include in a partial response. */
@@ -2858,19 +3359,27 @@ declare namespace gapi.client {
2858
3359
  prettyPrint?: boolean;
2859
3360
  /** Required. Project ID of the model to patch. */
2860
3361
  projectId: string;
2861
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3362
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2862
3363
  quotaUser?: string;
2863
- /** Deprecated. Please use quotaUser instead. */
2864
- userIp?: string;
3364
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3365
+ upload_protocol?: string;
3366
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3367
+ uploadType?: string;
2865
3368
  },
2866
3369
  body: Model
2867
3370
  ): Request<Model>;
2868
3371
  }
2869
3372
  interface ProjectsResource {
2870
- /** Returns the email address of the service account for your project used for interactions with Google Cloud KMS. */
3373
+ /** RPC to get the service account for a project used for interactions with Google Cloud KMS */
2871
3374
  getServiceAccount(request?: {
2872
- /** Data format for the response. */
3375
+ /** V1 error format. */
3376
+ '$.xgafv'?: string;
3377
+ /** OAuth access token. */
3378
+ access_token?: string;
3379
+ /** Data format for response. */
2873
3380
  alt?: string;
3381
+ /** JSONP */
3382
+ callback?: string;
2874
3383
  /** Selector specifying which fields to include in a partial response. */
2875
3384
  fields?: string;
2876
3385
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -2879,40 +3388,56 @@ declare namespace gapi.client {
2879
3388
  oauth_token?: string;
2880
3389
  /** Returns response with indentations and line breaks. */
2881
3390
  prettyPrint?: boolean;
2882
- /** Project ID for which the service account is requested. */
3391
+ /** Required. ID of the project. */
2883
3392
  projectId: string;
2884
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3393
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2885
3394
  quotaUser?: string;
2886
- /** Deprecated. Please use quotaUser instead. */
2887
- userIp?: string;
3395
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3396
+ upload_protocol?: string;
3397
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3398
+ uploadType?: string;
2888
3399
  }): Request<GetServiceAccountResponse>;
2889
- /** Lists all projects to which you have been granted any project role. */
3400
+ /** RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the [Resource Manager](https://cloud.google.com/resource-manager/docs/) API, which provides the underlying data for this method and has more capabilities. */
2890
3401
  list(request?: {
2891
- /** Data format for the response. */
3402
+ /** V1 error format. */
3403
+ '$.xgafv'?: string;
3404
+ /** OAuth access token. */
3405
+ access_token?: string;
3406
+ /** Data format for response. */
2892
3407
  alt?: string;
3408
+ /** JSONP */
3409
+ callback?: string;
2893
3410
  /** Selector specifying which fields to include in a partial response. */
2894
3411
  fields?: string;
2895
3412
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2896
3413
  key?: string;
2897
- /** Maximum number of results to return */
3414
+ /** `maxResults` unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than `maxResults` because projects are retrieved and then filtered to only projects with the BigQuery API enabled. */
2898
3415
  maxResults?: number;
2899
3416
  /** OAuth 2.0 token for the current user. */
2900
3417
  oauth_token?: string;
2901
- /** Page token, returned by a previous call, to request the next page of results */
3418
+ /** Page token, returned by a previous call, to request the next page of results. If not present, no further pages are present. */
2902
3419
  pageToken?: string;
2903
3420
  /** Returns response with indentations and line breaks. */
2904
3421
  prettyPrint?: boolean;
2905
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3422
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2906
3423
  quotaUser?: string;
2907
- /** Deprecated. Please use quotaUser instead. */
2908
- userIp?: string;
3424
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3425
+ upload_protocol?: string;
3426
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3427
+ uploadType?: string;
2909
3428
  }): Request<ProjectList>;
2910
3429
  }
2911
3430
  interface RoutinesResource {
2912
3431
  /** Deletes the routine specified by routineId from the dataset. */
2913
3432
  delete(request?: {
2914
- /** Data format for the response. */
3433
+ /** V1 error format. */
3434
+ '$.xgafv'?: string;
3435
+ /** OAuth access token. */
3436
+ access_token?: string;
3437
+ /** Data format for response. */
2915
3438
  alt?: string;
3439
+ /** JSONP */
3440
+ callback?: string;
2916
3441
  /** Required. Dataset ID of the routine to delete */
2917
3442
  datasetId: string;
2918
3443
  /** Selector specifying which fields to include in a partial response. */
@@ -2925,17 +3450,25 @@ declare namespace gapi.client {
2925
3450
  prettyPrint?: boolean;
2926
3451
  /** Required. Project ID of the routine to delete */
2927
3452
  projectId: string;
2928
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3453
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2929
3454
  quotaUser?: string;
2930
3455
  /** Required. Routine ID of the routine to delete */
2931
3456
  routineId: string;
2932
- /** Deprecated. Please use quotaUser instead. */
2933
- userIp?: string;
3457
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3458
+ upload_protocol?: string;
3459
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3460
+ uploadType?: string;
2934
3461
  }): Request<void>;
2935
3462
  /** Gets the specified routine resource by routine ID. */
2936
3463
  get(request?: {
2937
- /** Data format for the response. */
3464
+ /** V1 error format. */
3465
+ '$.xgafv'?: string;
3466
+ /** OAuth access token. */
3467
+ access_token?: string;
3468
+ /** Data format for response. */
2938
3469
  alt?: string;
3470
+ /** JSONP */
3471
+ callback?: string;
2939
3472
  /** Required. Dataset ID of the requested routine */
2940
3473
  datasetId: string;
2941
3474
  /** Selector specifying which fields to include in a partial response. */
@@ -2948,19 +3481,27 @@ declare namespace gapi.client {
2948
3481
  prettyPrint?: boolean;
2949
3482
  /** Required. Project ID of the requested routine */
2950
3483
  projectId: string;
2951
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3484
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2952
3485
  quotaUser?: string;
2953
3486
  /** If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned. */
2954
3487
  readMask?: string;
2955
3488
  /** Required. Routine ID of the requested routine */
2956
3489
  routineId: string;
2957
- /** Deprecated. Please use quotaUser instead. */
2958
- userIp?: string;
3490
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3491
+ upload_protocol?: string;
3492
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3493
+ uploadType?: string;
2959
3494
  }): Request<Routine>;
2960
3495
  /** Creates a new routine in the dataset. */
2961
3496
  insert(request: {
2962
- /** Data format for the response. */
3497
+ /** V1 error format. */
3498
+ '$.xgafv'?: string;
3499
+ /** OAuth access token. */
3500
+ access_token?: string;
3501
+ /** Data format for response. */
2963
3502
  alt?: string;
3503
+ /** JSONP */
3504
+ callback?: string;
2964
3505
  /** Required. Dataset ID of the new routine */
2965
3506
  datasetId: string;
2966
3507
  /** Selector specifying which fields to include in a partial response. */
@@ -2973,17 +3514,25 @@ declare namespace gapi.client {
2973
3514
  prettyPrint?: boolean;
2974
3515
  /** Required. Project ID of the new routine */
2975
3516
  projectId: string;
2976
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3517
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2977
3518
  quotaUser?: string;
2978
- /** Deprecated. Please use quotaUser instead. */
2979
- userIp?: string;
3519
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3520
+ upload_protocol?: string;
3521
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3522
+ uploadType?: string;
2980
3523
  /** Request body */
2981
3524
  resource: Routine;
2982
3525
  }): Request<Routine>;
2983
3526
  insert(
2984
3527
  request: {
2985
- /** Data format for the response. */
3528
+ /** V1 error format. */
3529
+ '$.xgafv'?: string;
3530
+ /** OAuth access token. */
3531
+ access_token?: string;
3532
+ /** Data format for response. */
2986
3533
  alt?: string;
3534
+ /** JSONP */
3535
+ callback?: string;
2987
3536
  /** Required. Dataset ID of the new routine */
2988
3537
  datasetId: string;
2989
3538
  /** Selector specifying which fields to include in a partial response. */
@@ -2996,17 +3545,25 @@ declare namespace gapi.client {
2996
3545
  prettyPrint?: boolean;
2997
3546
  /** Required. Project ID of the new routine */
2998
3547
  projectId: string;
2999
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3548
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3000
3549
  quotaUser?: string;
3001
- /** Deprecated. Please use quotaUser instead. */
3002
- userIp?: string;
3550
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3551
+ upload_protocol?: string;
3552
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3553
+ uploadType?: string;
3003
3554
  },
3004
3555
  body: Routine
3005
3556
  ): Request<Routine>;
3006
3557
  /** Lists all routines in the specified dataset. Requires the READER dataset role. */
3007
3558
  list(request?: {
3008
- /** Data format for the response. */
3559
+ /** V1 error format. */
3560
+ '$.xgafv'?: string;
3561
+ /** OAuth access token. */
3562
+ access_token?: string;
3563
+ /** Data format for response. */
3009
3564
  alt?: string;
3565
+ /** JSONP */
3566
+ callback?: string;
3010
3567
  /** Required. Dataset ID of the routines to list */
3011
3568
  datasetId: string;
3012
3569
  /** Selector specifying which fields to include in a partial response. */
@@ -3025,17 +3582,25 @@ declare namespace gapi.client {
3025
3582
  prettyPrint?: boolean;
3026
3583
  /** Required. Project ID of the routines to list */
3027
3584
  projectId: string;
3028
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3585
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3029
3586
  quotaUser?: string;
3030
3587
  /** If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language. */
3031
3588
  readMask?: string;
3032
- /** Deprecated. Please use quotaUser instead. */
3033
- userIp?: string;
3589
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3590
+ upload_protocol?: string;
3591
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3592
+ uploadType?: string;
3034
3593
  }): Request<ListRoutinesResponse>;
3035
3594
  /** Updates information in an existing routine. The update method replaces the entire Routine resource. */
3036
3595
  update(request: {
3037
- /** Data format for the response. */
3596
+ /** V1 error format. */
3597
+ '$.xgafv'?: string;
3598
+ /** OAuth access token. */
3599
+ access_token?: string;
3600
+ /** Data format for response. */
3038
3601
  alt?: string;
3602
+ /** JSONP */
3603
+ callback?: string;
3039
3604
  /** Required. Dataset ID of the routine to update */
3040
3605
  datasetId: string;
3041
3606
  /** Selector specifying which fields to include in a partial response. */
@@ -3048,19 +3613,27 @@ declare namespace gapi.client {
3048
3613
  prettyPrint?: boolean;
3049
3614
  /** Required. Project ID of the routine to update */
3050
3615
  projectId: string;
3051
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3616
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3052
3617
  quotaUser?: string;
3053
3618
  /** Required. Routine ID of the routine to update */
3054
3619
  routineId: string;
3055
- /** Deprecated. Please use quotaUser instead. */
3056
- userIp?: string;
3620
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3621
+ upload_protocol?: string;
3622
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3623
+ uploadType?: string;
3057
3624
  /** Request body */
3058
3625
  resource: Routine;
3059
3626
  }): Request<Routine>;
3060
3627
  update(
3061
3628
  request: {
3062
- /** Data format for the response. */
3629
+ /** V1 error format. */
3630
+ '$.xgafv'?: string;
3631
+ /** OAuth access token. */
3632
+ access_token?: string;
3633
+ /** Data format for response. */
3063
3634
  alt?: string;
3635
+ /** JSONP */
3636
+ callback?: string;
3064
3637
  /** Required. Dataset ID of the routine to update */
3065
3638
  datasetId: string;
3066
3639
  /** Selector specifying which fields to include in a partial response. */
@@ -3073,12 +3646,14 @@ declare namespace gapi.client {
3073
3646
  prettyPrint?: boolean;
3074
3647
  /** Required. Project ID of the routine to update */
3075
3648
  projectId: string;
3076
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3649
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3077
3650
  quotaUser?: string;
3078
3651
  /** Required. Routine ID of the routine to update */
3079
3652
  routineId: string;
3080
- /** Deprecated. Please use quotaUser instead. */
3081
- userIp?: string;
3653
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3654
+ upload_protocol?: string;
3655
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3656
+ uploadType?: string;
3082
3657
  },
3083
3658
  body: Routine
3084
3659
  ): Request<Routine>;
@@ -3087,8 +3662,14 @@ declare namespace gapi.client {
3087
3662
  /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
3088
3663
  getIamPolicy(
3089
3664
  request: {
3090
- /** Data format for the response. */
3665
+ /** V1 error format. */
3666
+ '$.xgafv'?: string;
3667
+ /** OAuth access token. */
3668
+ access_token?: string;
3669
+ /** Data format for response. */
3091
3670
  alt?: string;
3671
+ /** JSONP */
3672
+ callback?: string;
3092
3673
  /** Selector specifying which fields to include in a partial response. */
3093
3674
  fields?: string;
3094
3675
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -3097,19 +3678,27 @@ declare namespace gapi.client {
3097
3678
  oauth_token?: string;
3098
3679
  /** Returns response with indentations and line breaks. */
3099
3680
  prettyPrint?: boolean;
3100
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3681
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3101
3682
  quotaUser?: string;
3102
3683
  /** REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
3103
3684
  resource: string;
3104
- /** Deprecated. Please use quotaUser instead. */
3105
- userIp?: string;
3685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3686
+ upload_protocol?: string;
3687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3688
+ uploadType?: string;
3106
3689
  },
3107
3690
  body: GetIamPolicyRequest
3108
3691
  ): Request<Policy>;
3109
3692
  /** Lists all row access policies on the specified table. */
3110
3693
  list(request?: {
3111
- /** Data format for the response. */
3694
+ /** V1 error format. */
3695
+ '$.xgafv'?: string;
3696
+ /** OAuth access token. */
3697
+ access_token?: string;
3698
+ /** Data format for response. */
3112
3699
  alt?: string;
3700
+ /** JSONP */
3701
+ callback?: string;
3113
3702
  /** Required. Dataset ID of row access policies to list. */
3114
3703
  datasetId: string;
3115
3704
  /** Selector specifying which fields to include in a partial response. */
@@ -3126,18 +3715,26 @@ declare namespace gapi.client {
3126
3715
  prettyPrint?: boolean;
3127
3716
  /** Required. Project ID of the row access policies to list. */
3128
3717
  projectId: string;
3129
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3718
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3130
3719
  quotaUser?: string;
3131
3720
  /** Required. Table ID of the table to list row access policies. */
3132
3721
  tableId: string;
3133
- /** Deprecated. Please use quotaUser instead. */
3134
- userIp?: string;
3722
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3723
+ upload_protocol?: string;
3724
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3725
+ uploadType?: string;
3135
3726
  }): Request<ListRowAccessPoliciesResponse>;
3136
3727
  /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
3137
3728
  testIamPermissions(
3138
3729
  request: {
3139
- /** Data format for the response. */
3730
+ /** V1 error format. */
3731
+ '$.xgafv'?: string;
3732
+ /** OAuth access token. */
3733
+ access_token?: string;
3734
+ /** Data format for response. */
3140
3735
  alt?: string;
3736
+ /** JSONP */
3737
+ callback?: string;
3141
3738
  /** Selector specifying which fields to include in a partial response. */
3142
3739
  fields?: string;
3143
3740
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -3146,22 +3743,30 @@ declare namespace gapi.client {
3146
3743
  oauth_token?: string;
3147
3744
  /** Returns response with indentations and line breaks. */
3148
3745
  prettyPrint?: boolean;
3149
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3746
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3150
3747
  quotaUser?: string;
3151
3748
  /** REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
3152
3749
  resource: string;
3153
- /** Deprecated. Please use quotaUser instead. */
3154
- userIp?: string;
3750
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3751
+ upload_protocol?: string;
3752
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3753
+ uploadType?: string;
3155
3754
  },
3156
3755
  body: TestIamPermissionsRequest
3157
3756
  ): Request<TestIamPermissionsResponse>;
3158
3757
  }
3159
3758
  interface TabledataResource {
3160
- /** Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role. */
3759
+ /** Streams data into BigQuery one record at a time without needing to run a load job. */
3161
3760
  insertAll(request: {
3162
- /** Data format for the response. */
3761
+ /** V1 error format. */
3762
+ '$.xgafv'?: string;
3763
+ /** OAuth access token. */
3764
+ access_token?: string;
3765
+ /** Data format for response. */
3163
3766
  alt?: string;
3164
- /** Dataset ID of the destination table. */
3767
+ /** JSONP */
3768
+ callback?: string;
3769
+ /** Required. Dataset ID of the destination. */
3165
3770
  datasetId: string;
3166
3771
  /** Selector specifying which fields to include in a partial response. */
3167
3772
  fields?: string;
@@ -3171,22 +3776,30 @@ declare namespace gapi.client {
3171
3776
  oauth_token?: string;
3172
3777
  /** Returns response with indentations and line breaks. */
3173
3778
  prettyPrint?: boolean;
3174
- /** Project ID of the destination table. */
3779
+ /** Required. Project ID of the destination. */
3175
3780
  projectId: string;
3176
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3781
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3177
3782
  quotaUser?: string;
3178
- /** Table ID of the destination table. */
3783
+ /** Required. Table ID of the destination. */
3179
3784
  tableId: string;
3180
- /** Deprecated. Please use quotaUser instead. */
3181
- userIp?: string;
3785
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3786
+ upload_protocol?: string;
3787
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3788
+ uploadType?: string;
3182
3789
  /** Request body */
3183
3790
  resource: TableDataInsertAllRequest;
3184
3791
  }): Request<TableDataInsertAllResponse>;
3185
3792
  insertAll(
3186
3793
  request: {
3187
- /** Data format for the response. */
3794
+ /** V1 error format. */
3795
+ '$.xgafv'?: string;
3796
+ /** OAuth access token. */
3797
+ access_token?: string;
3798
+ /** Data format for response. */
3188
3799
  alt?: string;
3189
- /** Dataset ID of the destination table. */
3800
+ /** JSONP */
3801
+ callback?: string;
3802
+ /** Required. Dataset ID of the destination. */
3190
3803
  datasetId: string;
3191
3804
  /** Selector specifying which fields to include in a partial response. */
3192
3805
  fields?: string;
@@ -3196,55 +3809,73 @@ declare namespace gapi.client {
3196
3809
  oauth_token?: string;
3197
3810
  /** Returns response with indentations and line breaks. */
3198
3811
  prettyPrint?: boolean;
3199
- /** Project ID of the destination table. */
3812
+ /** Required. Project ID of the destination. */
3200
3813
  projectId: string;
3201
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3814
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3202
3815
  quotaUser?: string;
3203
- /** Table ID of the destination table. */
3816
+ /** Required. Table ID of the destination. */
3204
3817
  tableId: string;
3205
- /** Deprecated. Please use quotaUser instead. */
3206
- userIp?: string;
3818
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3819
+ upload_protocol?: string;
3820
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3821
+ uploadType?: string;
3207
3822
  },
3208
3823
  body: TableDataInsertAllRequest
3209
3824
  ): Request<TableDataInsertAllResponse>;
3210
- /** Retrieves table data from a specified set of rows. Requires the READER dataset role. */
3825
+ /** List the content of a table in rows. */
3211
3826
  list(request?: {
3212
- /** Data format for the response. */
3827
+ /** V1 error format. */
3828
+ '$.xgafv'?: string;
3829
+ /** OAuth access token. */
3830
+ access_token?: string;
3831
+ /** Data format for response. */
3213
3832
  alt?: string;
3214
- /** Dataset ID of the table to read */
3833
+ /** JSONP */
3834
+ callback?: string;
3835
+ /** Required. Dataset id of the table to list. */
3215
3836
  datasetId: string;
3216
3837
  /** Selector specifying which fields to include in a partial response. */
3217
3838
  fields?: string;
3839
+ /** Optional. Output timestamp as usec int64. Default is false. */
3840
+ 'formatOptions.useInt64Timestamp'?: boolean;
3218
3841
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3219
3842
  key?: string;
3220
- /** Maximum number of results to return */
3843
+ /** Row limit of the table. */
3221
3844
  maxResults?: number;
3222
3845
  /** OAuth 2.0 token for the current user. */
3223
3846
  oauth_token?: string;
3224
- /** Page token, returned by a previous call, identifying the result set */
3847
+ /** To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list. */
3225
3848
  pageToken?: string;
3226
3849
  /** Returns response with indentations and line breaks. */
3227
3850
  prettyPrint?: boolean;
3228
- /** Project ID of the table to read */
3851
+ /** Required. Project id of the table to list. */
3229
3852
  projectId: string;
3230
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3853
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3231
3854
  quotaUser?: string;
3232
- /** List of fields to return (comma-separated). If unspecified, all fields are returned */
3855
+ /** Subset of fields to return, supports select into sub fields. Example: selected_fields = "a,e.d.f"; */
3233
3856
  selectedFields?: string;
3234
- /** Zero-based index of the starting row to read */
3857
+ /** Start row index of the table. */
3235
3858
  startIndex?: string;
3236
- /** Table ID of the table to read */
3859
+ /** Required. Table id of the table to list. */
3237
3860
  tableId: string;
3238
- /** Deprecated. Please use quotaUser instead. */
3239
- userIp?: string;
3861
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3862
+ upload_protocol?: string;
3863
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3864
+ uploadType?: string;
3240
3865
  }): Request<TableDataList>;
3241
3866
  }
3242
3867
  interface TablesResource {
3243
3868
  /** Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. */
3244
3869
  delete(request?: {
3245
- /** Data format for the response. */
3870
+ /** V1 error format. */
3871
+ '$.xgafv'?: string;
3872
+ /** OAuth access token. */
3873
+ access_token?: string;
3874
+ /** Data format for response. */
3246
3875
  alt?: string;
3247
- /** Dataset ID of the table to delete */
3876
+ /** JSONP */
3877
+ callback?: string;
3878
+ /** Required. Dataset ID of the table to delete */
3248
3879
  datasetId: string;
3249
3880
  /** Selector specifying which fields to include in a partial response. */
3250
3881
  fields?: string;
@@ -3254,20 +3885,28 @@ declare namespace gapi.client {
3254
3885
  oauth_token?: string;
3255
3886
  /** Returns response with indentations and line breaks. */
3256
3887
  prettyPrint?: boolean;
3257
- /** Project ID of the table to delete */
3888
+ /** Required. Project ID of the table to delete */
3258
3889
  projectId: string;
3259
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3890
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3260
3891
  quotaUser?: string;
3261
- /** Table ID of the table to delete */
3892
+ /** Required. Table ID of the table to delete */
3262
3893
  tableId: string;
3263
- /** Deprecated. Please use quotaUser instead. */
3264
- userIp?: string;
3894
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3895
+ upload_protocol?: string;
3896
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3897
+ uploadType?: string;
3265
3898
  }): Request<void>;
3266
3899
  /** Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. */
3267
3900
  get(request?: {
3268
- /** Data format for the response. */
3901
+ /** V1 error format. */
3902
+ '$.xgafv'?: string;
3903
+ /** OAuth access token. */
3904
+ access_token?: string;
3905
+ /** Data format for response. */
3269
3906
  alt?: string;
3270
- /** Dataset ID of the requested table */
3907
+ /** JSONP */
3908
+ callback?: string;
3909
+ /** Required. Dataset ID of the requested table */
3271
3910
  datasetId: string;
3272
3911
  /** Selector specifying which fields to include in a partial response. */
3273
3912
  fields?: string;
@@ -3277,24 +3916,32 @@ declare namespace gapi.client {
3277
3916
  oauth_token?: string;
3278
3917
  /** Returns response with indentations and line breaks. */
3279
3918
  prettyPrint?: boolean;
3280
- /** Project ID of the requested table */
3919
+ /** Required. Project ID of the requested table */
3281
3920
  projectId: string;
3282
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3921
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3283
3922
  quotaUser?: string;
3284
- /** List of fields to return (comma-separated). If unspecified, all fields are returned */
3923
+ /** List of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed. */
3285
3924
  selectedFields?: string;
3286
- /** Table ID of the requested table */
3925
+ /** Required. Table ID of the requested table */
3287
3926
  tableId: string;
3288
- /** Deprecated. Please use quotaUser instead. */
3289
- userIp?: string;
3290
- /** Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned. */
3927
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3928
+ upload_protocol?: string;
3929
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3930
+ uploadType?: string;
3931
+ /** Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned. */
3291
3932
  view?: string;
3292
3933
  }): Request<Table>;
3293
3934
  /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
3294
3935
  getIamPolicy(
3295
3936
  request: {
3296
- /** Data format for the response. */
3937
+ /** V1 error format. */
3938
+ '$.xgafv'?: string;
3939
+ /** OAuth access token. */
3940
+ access_token?: string;
3941
+ /** Data format for response. */
3297
3942
  alt?: string;
3943
+ /** JSONP */
3944
+ callback?: string;
3298
3945
  /** Selector specifying which fields to include in a partial response. */
3299
3946
  fields?: string;
3300
3947
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -3303,20 +3950,28 @@ declare namespace gapi.client {
3303
3950
  oauth_token?: string;
3304
3951
  /** Returns response with indentations and line breaks. */
3305
3952
  prettyPrint?: boolean;
3306
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3953
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3307
3954
  quotaUser?: string;
3308
3955
  /** REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
3309
3956
  resource: string;
3310
- /** Deprecated. Please use quotaUser instead. */
3311
- userIp?: string;
3957
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3958
+ upload_protocol?: string;
3959
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3960
+ uploadType?: string;
3312
3961
  },
3313
3962
  body: GetIamPolicyRequest
3314
3963
  ): Request<Policy>;
3315
3964
  /** Creates a new, empty table in the dataset. */
3316
3965
  insert(request: {
3317
- /** Data format for the response. */
3966
+ /** V1 error format. */
3967
+ '$.xgafv'?: string;
3968
+ /** OAuth access token. */
3969
+ access_token?: string;
3970
+ /** Data format for response. */
3318
3971
  alt?: string;
3319
- /** Dataset ID of the new table */
3972
+ /** JSONP */
3973
+ callback?: string;
3974
+ /** Required. Dataset ID of the new table */
3320
3975
  datasetId: string;
3321
3976
  /** Selector specifying which fields to include in a partial response. */
3322
3977
  fields?: string;
@@ -3326,20 +3981,28 @@ declare namespace gapi.client {
3326
3981
  oauth_token?: string;
3327
3982
  /** Returns response with indentations and line breaks. */
3328
3983
  prettyPrint?: boolean;
3329
- /** Project ID of the new table */
3984
+ /** Required. Project ID of the new table */
3330
3985
  projectId: string;
3331
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
3986
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3332
3987
  quotaUser?: string;
3333
- /** Deprecated. Please use quotaUser instead. */
3334
- userIp?: string;
3988
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3989
+ upload_protocol?: string;
3990
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3991
+ uploadType?: string;
3335
3992
  /** Request body */
3336
3993
  resource: Table;
3337
3994
  }): Request<Table>;
3338
3995
  insert(
3339
3996
  request: {
3340
- /** Data format for the response. */
3997
+ /** V1 error format. */
3998
+ '$.xgafv'?: string;
3999
+ /** OAuth access token. */
4000
+ access_token?: string;
4001
+ /** Data format for response. */
3341
4002
  alt?: string;
3342
- /** Dataset ID of the new table */
4003
+ /** JSONP */
4004
+ callback?: string;
4005
+ /** Required. Dataset ID of the new table */
3343
4006
  datasetId: string;
3344
4007
  /** Selector specifying which fields to include in a partial response. */
3345
4008
  fields?: string;
@@ -3349,26 +4012,34 @@ declare namespace gapi.client {
3349
4012
  oauth_token?: string;
3350
4013
  /** Returns response with indentations and line breaks. */
3351
4014
  prettyPrint?: boolean;
3352
- /** Project ID of the new table */
4015
+ /** Required. Project ID of the new table */
3353
4016
  projectId: string;
3354
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4017
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3355
4018
  quotaUser?: string;
3356
- /** Deprecated. Please use quotaUser instead. */
3357
- userIp?: string;
4019
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4020
+ upload_protocol?: string;
4021
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4022
+ uploadType?: string;
3358
4023
  },
3359
4024
  body: Table
3360
4025
  ): Request<Table>;
3361
4026
  /** Lists all tables in the specified dataset. Requires the READER dataset role. */
3362
4027
  list(request?: {
3363
- /** Data format for the response. */
4028
+ /** V1 error format. */
4029
+ '$.xgafv'?: string;
4030
+ /** OAuth access token. */
4031
+ access_token?: string;
4032
+ /** Data format for response. */
3364
4033
  alt?: string;
3365
- /** Dataset ID of the tables to list */
4034
+ /** JSONP */
4035
+ callback?: string;
4036
+ /** Required. Dataset ID of the tables to list */
3366
4037
  datasetId: string;
3367
4038
  /** Selector specifying which fields to include in a partial response. */
3368
4039
  fields?: string;
3369
4040
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3370
4041
  key?: string;
3371
- /** Maximum number of results to return */
4042
+ /** The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. */
3372
4043
  maxResults?: number;
3373
4044
  /** OAuth 2.0 token for the current user. */
3374
4045
  oauth_token?: string;
@@ -3376,20 +4047,28 @@ declare namespace gapi.client {
3376
4047
  pageToken?: string;
3377
4048
  /** Returns response with indentations and line breaks. */
3378
4049
  prettyPrint?: boolean;
3379
- /** Project ID of the tables to list */
4050
+ /** Required. Project ID of the tables to list */
3380
4051
  projectId: string;
3381
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4052
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3382
4053
  quotaUser?: string;
3383
- /** Deprecated. Please use quotaUser instead. */
3384
- userIp?: string;
4054
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4055
+ upload_protocol?: string;
4056
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4057
+ uploadType?: string;
3385
4058
  }): Request<TableList>;
3386
- /** Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics. */
4059
+ /** Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics. */
3387
4060
  patch(request: {
3388
- /** Data format for the response. */
4061
+ /** V1 error format. */
4062
+ '$.xgafv'?: string;
4063
+ /** OAuth access token. */
4064
+ access_token?: string;
4065
+ /** Data format for response. */
3389
4066
  alt?: string;
3390
- /** When true will autodetect schema, else will keep original schema */
4067
+ /** Optional. When true will autodetect schema, else will keep original schema */
3391
4068
  autodetect_schema?: boolean;
3392
- /** Dataset ID of the table to update */
4069
+ /** JSONP */
4070
+ callback?: string;
4071
+ /** Required. Dataset ID of the table to update */
3393
4072
  datasetId: string;
3394
4073
  /** Selector specifying which fields to include in a partial response. */
3395
4074
  fields?: string;
@@ -3399,24 +4078,32 @@ declare namespace gapi.client {
3399
4078
  oauth_token?: string;
3400
4079
  /** Returns response with indentations and line breaks. */
3401
4080
  prettyPrint?: boolean;
3402
- /** Project ID of the table to update */
4081
+ /** Required. Project ID of the table to update */
3403
4082
  projectId: string;
3404
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4083
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3405
4084
  quotaUser?: string;
3406
- /** Table ID of the table to update */
4085
+ /** Required. Table ID of the table to update */
3407
4086
  tableId: string;
3408
- /** Deprecated. Please use quotaUser instead. */
3409
- userIp?: string;
4087
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4088
+ upload_protocol?: string;
4089
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4090
+ uploadType?: string;
3410
4091
  /** Request body */
3411
4092
  resource: Table;
3412
4093
  }): Request<Table>;
3413
4094
  patch(
3414
4095
  request: {
3415
- /** Data format for the response. */
4096
+ /** V1 error format. */
4097
+ '$.xgafv'?: string;
4098
+ /** OAuth access token. */
4099
+ access_token?: string;
4100
+ /** Data format for response. */
3416
4101
  alt?: string;
3417
- /** When true will autodetect schema, else will keep original schema */
4102
+ /** Optional. When true will autodetect schema, else will keep original schema */
3418
4103
  autodetect_schema?: boolean;
3419
- /** Dataset ID of the table to update */
4104
+ /** JSONP */
4105
+ callback?: string;
4106
+ /** Required. Dataset ID of the table to update */
3420
4107
  datasetId: string;
3421
4108
  /** Selector specifying which fields to include in a partial response. */
3422
4109
  fields?: string;
@@ -3426,22 +4113,30 @@ declare namespace gapi.client {
3426
4113
  oauth_token?: string;
3427
4114
  /** Returns response with indentations and line breaks. */
3428
4115
  prettyPrint?: boolean;
3429
- /** Project ID of the table to update */
4116
+ /** Required. Project ID of the table to update */
3430
4117
  projectId: string;
3431
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4118
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3432
4119
  quotaUser?: string;
3433
- /** Table ID of the table to update */
4120
+ /** Required. Table ID of the table to update */
3434
4121
  tableId: string;
3435
- /** Deprecated. Please use quotaUser instead. */
3436
- userIp?: string;
4122
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4123
+ upload_protocol?: string;
4124
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4125
+ uploadType?: string;
3437
4126
  },
3438
4127
  body: Table
3439
4128
  ): Request<Table>;
3440
4129
  /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
3441
4130
  setIamPolicy(
3442
4131
  request: {
3443
- /** Data format for the response. */
4132
+ /** V1 error format. */
4133
+ '$.xgafv'?: string;
4134
+ /** OAuth access token. */
4135
+ access_token?: string;
4136
+ /** Data format for response. */
3444
4137
  alt?: string;
4138
+ /** JSONP */
4139
+ callback?: string;
3445
4140
  /** Selector specifying which fields to include in a partial response. */
3446
4141
  fields?: string;
3447
4142
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -3450,20 +4145,28 @@ declare namespace gapi.client {
3450
4145
  oauth_token?: string;
3451
4146
  /** Returns response with indentations and line breaks. */
3452
4147
  prettyPrint?: boolean;
3453
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4148
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3454
4149
  quotaUser?: string;
3455
4150
  /** REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
3456
4151
  resource: string;
3457
- /** Deprecated. Please use quotaUser instead. */
3458
- userIp?: string;
4152
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4153
+ upload_protocol?: string;
4154
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4155
+ uploadType?: string;
3459
4156
  },
3460
4157
  body: SetIamPolicyRequest
3461
4158
  ): Request<Policy>;
3462
4159
  /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
3463
4160
  testIamPermissions(
3464
4161
  request: {
3465
- /** Data format for the response. */
4162
+ /** V1 error format. */
4163
+ '$.xgafv'?: string;
4164
+ /** OAuth access token. */
4165
+ access_token?: string;
4166
+ /** Data format for response. */
3466
4167
  alt?: string;
4168
+ /** JSONP */
4169
+ callback?: string;
3467
4170
  /** Selector specifying which fields to include in a partial response. */
3468
4171
  fields?: string;
3469
4172
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -3472,22 +4175,30 @@ declare namespace gapi.client {
3472
4175
  oauth_token?: string;
3473
4176
  /** Returns response with indentations and line breaks. */
3474
4177
  prettyPrint?: boolean;
3475
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4178
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3476
4179
  quotaUser?: string;
3477
4180
  /** REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
3478
4181
  resource: string;
3479
- /** Deprecated. Please use quotaUser instead. */
3480
- userIp?: string;
4182
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4183
+ upload_protocol?: string;
4184
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4185
+ uploadType?: string;
3481
4186
  },
3482
4187
  body: TestIamPermissionsRequest
3483
4188
  ): Request<TestIamPermissionsResponse>;
3484
- /** Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. */
4189
+ /** Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource. */
3485
4190
  update(request: {
3486
- /** Data format for the response. */
4191
+ /** V1 error format. */
4192
+ '$.xgafv'?: string;
4193
+ /** OAuth access token. */
4194
+ access_token?: string;
4195
+ /** Data format for response. */
3487
4196
  alt?: string;
3488
- /** When true will autodetect schema, else will keep original schema */
4197
+ /** Optional. When true will autodetect schema, else will keep original schema */
3489
4198
  autodetect_schema?: boolean;
3490
- /** Dataset ID of the table to update */
4199
+ /** JSONP */
4200
+ callback?: string;
4201
+ /** Required. Dataset ID of the table to update */
3491
4202
  datasetId: string;
3492
4203
  /** Selector specifying which fields to include in a partial response. */
3493
4204
  fields?: string;
@@ -3497,24 +4208,32 @@ declare namespace gapi.client {
3497
4208
  oauth_token?: string;
3498
4209
  /** Returns response with indentations and line breaks. */
3499
4210
  prettyPrint?: boolean;
3500
- /** Project ID of the table to update */
4211
+ /** Required. Project ID of the table to update */
3501
4212
  projectId: string;
3502
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4213
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3503
4214
  quotaUser?: string;
3504
- /** Table ID of the table to update */
4215
+ /** Required. Table ID of the table to update */
3505
4216
  tableId: string;
3506
- /** Deprecated. Please use quotaUser instead. */
3507
- userIp?: string;
4217
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4218
+ upload_protocol?: string;
4219
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4220
+ uploadType?: string;
3508
4221
  /** Request body */
3509
4222
  resource: Table;
3510
4223
  }): Request<Table>;
3511
4224
  update(
3512
4225
  request: {
3513
- /** Data format for the response. */
4226
+ /** V1 error format. */
4227
+ '$.xgafv'?: string;
4228
+ /** OAuth access token. */
4229
+ access_token?: string;
4230
+ /** Data format for response. */
3514
4231
  alt?: string;
3515
- /** When true will autodetect schema, else will keep original schema */
4232
+ /** Optional. When true will autodetect schema, else will keep original schema */
3516
4233
  autodetect_schema?: boolean;
3517
- /** Dataset ID of the table to update */
4234
+ /** JSONP */
4235
+ callback?: string;
4236
+ /** Required. Dataset ID of the table to update */
3518
4237
  datasetId: string;
3519
4238
  /** Selector specifying which fields to include in a partial response. */
3520
4239
  fields?: string;
@@ -3524,14 +4243,16 @@ declare namespace gapi.client {
3524
4243
  oauth_token?: string;
3525
4244
  /** Returns response with indentations and line breaks. */
3526
4245
  prettyPrint?: boolean;
3527
- /** Project ID of the table to update */
4246
+ /** Required. Project ID of the table to update */
3528
4247
  projectId: string;
3529
- /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
4248
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3530
4249
  quotaUser?: string;
3531
- /** Table ID of the table to update */
4250
+ /** Required. Table ID of the table to update */
3532
4251
  tableId: string;
3533
- /** Deprecated. Please use quotaUser instead. */
3534
- userIp?: string;
4252
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4253
+ upload_protocol?: string;
4254
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4255
+ uploadType?: string;
3535
4256
  },
3536
4257
  body: Table
3537
4258
  ): Request<Table>;