@maxim_mazurok/gapi.client.bigquery-v2 0.1.20250816 → 0.1.20250912

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 (2) hide show
  1. package/index.d.ts +54 -6
  2. package/package.json +1 -1
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: 20250816
12
+ // Revision: 20250912
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -800,7 +800,7 @@ declare namespace gapi.client {
800
800
  runtimeVersion?: string;
801
801
  }
802
802
  interface ExternalServiceCost {
803
- /** The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. */
803
+ /** The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. */
804
804
  billingMethod?: string;
805
805
  /** External service cost in terms of bigquery bytes billed. */
806
806
  bytesBilled?: string;
@@ -971,6 +971,22 @@ declare namespace gapi.client {
971
971
  /** 1-based index of the trial. */
972
972
  trialId?: string;
973
973
  }
974
+ interface IncrementalResultStats {
975
+ /** Reason why incremental query results are/were not written by the query. */
976
+ disabledReason?: string;
977
+ /** The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. */
978
+ resultSetLastModifyTime?: string;
979
+ /** The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. */
980
+ resultSetLastReplaceTime?: string;
981
+ }
982
+ interface IndexPruningStats {
983
+ /** The base table reference. */
984
+ baseTable?: TableReference;
985
+ /** The number of parallel inputs after index pruning. */
986
+ postIndexPruningParallelInputCount?: string;
987
+ /** The number of parallel inputs before index pruning. */
988
+ preIndexPruningParallelInputCount?: string;
989
+ }
974
990
  interface IndexUnusedReason {
975
991
  /** Specifies the base table involved in the reason that no search index was used. */
976
992
  baseTable?: TableReference;
@@ -1064,7 +1080,7 @@ declare namespace gapi.client {
1064
1080
  dryRun?: boolean;
1065
1081
  /** [Pick one] Configures an extract job. */
1066
1082
  extract?: JobConfigurationExtract;
1067
- /** Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. */
1083
+ /** Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. */
1068
1084
  jobTimeoutMs?: string;
1069
1085
  /** Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. */
1070
1086
  jobType?: string;
@@ -1168,7 +1184,7 @@ declare namespace gapi.client {
1168
1184
  schemaInline?: string;
1169
1185
  /** [Deprecated] The format of the schemaInline property. */
1170
1186
  schemaInlineFormat?: string;
1171
- /** 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. */
1187
+ /** Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
1172
1188
  schemaUpdateOptions?: string[];
1173
1189
  /** 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. */
1174
1190
  skipLeadingRows?: number;
@@ -1228,7 +1244,7 @@ declare namespace gapi.client {
1228
1244
  queryParameters?: QueryParameter[];
1229
1245
  /** Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */
1230
1246
  rangePartitioning?: RangePartitioning;
1231
- /** 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. */
1247
+ /** Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
1232
1248
  schemaUpdateOptions?: string[];
1233
1249
  /** Options controlling the execution of scripts. */
1234
1250
  scriptOptions?: ScriptOptions;
@@ -1398,6 +1414,8 @@ declare namespace gapi.client {
1398
1414
  exportDataStatistics?: ExportDataStatistics;
1399
1415
  /** Output only. Job cost breakdown as bigquery internal cost and external service costs. */
1400
1416
  externalServiceCosts?: ExternalServiceCost[];
1417
+ /** Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. */
1418
+ incrementalResultStats?: IncrementalResultStats;
1401
1419
  /** Output only. Statistics for a LOAD query. */
1402
1420
  loadQueryStatistics?: LoadQueryStatistics;
1403
1421
  /** Output only. Statistics of materialized views of a query job. */
@@ -1449,7 +1467,7 @@ declare namespace gapi.client {
1449
1467
  totalBytesProcessedAccuracy?: string;
1450
1468
  /** Output only. Total number of partitions processed from all partitioned tables referenced in the job. */
1451
1469
  totalPartitionsProcessed?: string;
1452
- /** Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". */
1470
+ /** Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. */
1453
1471
  totalServicesSkuSlotMs?: string;
1454
1472
  /** Output only. Slot-milliseconds for the job. */
1455
1473
  totalSlotMs?: string;
@@ -1759,6 +1777,14 @@ declare namespace gapi.client {
1759
1777
  /** Required. ID of the project. Can be either the numeric ID or the assigned ID of the project. */
1760
1778
  projectId?: string;
1761
1779
  }
1780
+ interface PruningStats {
1781
+ /** The number of parallel inputs matched. */
1782
+ postCmetaPruningParallelInputCount?: string;
1783
+ /** The number of partitions matched. */
1784
+ postCmetaPruningPartitionCount?: string;
1785
+ /** The number of parallel inputs scanned. */
1786
+ preCmetaPruningParallelInputCount?: string;
1787
+ }
1762
1788
  interface PythonOptions {
1763
1789
  /** Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. */
1764
1790
  entryPoint?: string;
@@ -2100,6 +2126,8 @@ declare namespace gapi.client {
2100
2126
  stackFrames?: ScriptStackFrame[];
2101
2127
  }
2102
2128
  interface SearchStatistics {
2129
+ /** Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. */
2130
+ indexPruningStats?: IndexPruningStats[];
2103
2131
  /** 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. */
2104
2132
  indexUnusedReasons?: IndexUnusedReason[];
2105
2133
  /** Specifies the index usage mode for the query. */
@@ -2527,6 +2555,8 @@ declare namespace gapi.client {
2527
2555
  interface TableMetadataCacheUsage {
2528
2556
  /** Free form human-readable reason metadata caching was unused for the job. */
2529
2557
  explanation?: string;
2558
+ /** The column metadata index pruning statistics. */
2559
+ pruningStats?: PruningStats;
2530
2560
  /** Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). */
2531
2561
  staleness?: string;
2532
2562
  /** Metadata caching eligible table referenced in the query. */
@@ -2643,6 +2673,8 @@ declare namespace gapi.client {
2643
2673
  earlyStop?: boolean;
2644
2674
  /** If true, enable global explanation during training. */
2645
2675
  enableGlobalExplain?: boolean;
2676
+ /** The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. */
2677
+ endpointIdleTtl?: string;
2646
2678
  /** Feedback type that specifies which algorithm to run for matrix factorization. */
2647
2679
  feedbackType?: string;
2648
2680
  /** Whether the model should include intercept during model training. */
@@ -2661,6 +2693,8 @@ declare namespace gapi.client {
2661
2693
  horizon?: string;
2662
2694
  /** The target evaluation metrics to optimize the hyperparameters for. */
2663
2695
  hparamTuningObjectives?: string[];
2696
+ /** The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. */
2697
+ huggingFaceModelId?: string;
2664
2698
  /** Include drift when fitting an ARIMA model. */
2665
2699
  includeDrift?: boolean;
2666
2700
  /** Specifies the initial learning rate for the line search learn rate strategy. */
@@ -2693,10 +2727,14 @@ declare namespace gapi.client {
2693
2727
  learnRateStrategy?: string;
2694
2728
  /** Type of loss function used during training run. */
2695
2729
  lossType?: string;
2730
+ /** The type of the machine used to deploy and serve the model. */
2731
+ machineType?: string;
2696
2732
  /** The maximum number of iterations in training. Used only for iterative training algorithms. */
2697
2733
  maxIterations?: string;
2698
2734
  /** Maximum number of trials to run in parallel. */
2699
2735
  maxParallelTrials?: string;
2736
+ /** The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. */
2737
+ maxReplicaCount?: string;
2700
2738
  /** The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. */
2701
2739
  maxTimeSeriesLength?: string;
2702
2740
  /** Maximum depth of a tree for boosted tree models. */
@@ -2705,12 +2743,16 @@ declare namespace gapi.client {
2705
2743
  minAprioriSupport?: number;
2706
2744
  /** When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. */
2707
2745
  minRelativeProgress?: number;
2746
+ /** The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. */
2747
+ minReplicaCount?: string;
2708
2748
  /** Minimum split loss for boosted tree models. */
2709
2749
  minSplitLoss?: number;
2710
2750
  /** The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. */
2711
2751
  minTimeSeriesLength?: string;
2712
2752
  /** Minimum sum of instance weight needed in a child for boosted tree models. */
2713
2753
  minTreeChildWeight?: string;
2754
+ /** The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. */
2755
+ modelGardenModelName?: string;
2714
2756
  /** The model registry. */
2715
2757
  modelRegistry?: string;
2716
2758
  /** Google Cloud Storage URI from which the model was imported. Only applicable for imported models. */
@@ -2735,6 +2777,12 @@ declare namespace gapi.client {
2735
2777
  pcaExplainedVarianceRatio?: number;
2736
2778
  /** The solver for PCA. */
2737
2779
  pcaSolver?: string;
2780
+ /** Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. */
2781
+ reservationAffinityKey?: string;
2782
+ /** Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. */
2783
+ reservationAffinityType?: string;
2784
+ /** Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. */
2785
+ reservationAffinityValues?: string[];
2738
2786
  /** Number of paths for the sampled Shapley explain method. */
2739
2787
  sampledShapleyNumPaths?: string;
2740
2788
  /** If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.bigquery-v2",
3
- "version": "0.1.20250816",
3
+ "version": "0.1.20250912",
4
4
  "description": "TypeScript typings for BigQuery API v2",
5
5
  "repository": {
6
6
  "type": "git",