Skip to content

Commit 40417ba

Browse files
chore: update types from Discovery (#1543)
1 parent 40cef99 commit 40417ba

File tree

1 file changed

+112
-6
lines changed

1 file changed

+112
-6
lines changed

src/types.d.ts

Lines changed: 112 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// limitations under the License.
1414

1515
/**
16-
* Discovery Revision: 20250816
16+
* Discovery Revision: 20250912
1717
*/
1818

1919
/**
@@ -1753,7 +1753,7 @@ declare namespace bigquery {
17531753
*/
17541754
type IExternalServiceCost = {
17551755
/**
1756-
* 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.
1756+
* 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.
17571757
*/
17581758
billingMethod?: string;
17591759
/**
@@ -2127,6 +2127,42 @@ declare namespace bigquery {
21272127
trialId?: string;
21282128
};
21292129

2130+
/**
2131+
* Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available.
2132+
*/
2133+
type IIncrementalResultStats = {
2134+
/**
2135+
* Reason why incremental query results are/were not written by the query.
2136+
*/
2137+
disabledReason?: 'DISABLED_REASON_UNSPECIFIED' | 'OTHER';
2138+
/**
2139+
* 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.
2140+
*/
2141+
resultSetLastModifyTime?: string;
2142+
/**
2143+
* 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.
2144+
*/
2145+
resultSetLastReplaceTime?: string;
2146+
};
2147+
2148+
/**
2149+
* Statistics for index pruning.
2150+
*/
2151+
type IIndexPruningStats = {
2152+
/**
2153+
* The base table reference.
2154+
*/
2155+
baseTable?: ITableReference;
2156+
/**
2157+
* The number of parallel inputs after index pruning.
2158+
*/
2159+
postIndexPruningParallelInputCount?: string;
2160+
/**
2161+
* The number of parallel inputs before index pruning.
2162+
*/
2163+
preIndexPruningParallelInputCount?: string;
2164+
};
2165+
21302166
/**
21312167
* Reason about why no search index was used in the search query (or sub-query).
21322168
*/
@@ -2352,7 +2388,7 @@ declare namespace bigquery {
23522388
*/
23532389
extract?: IJobConfigurationExtract;
23542390
/**
2355-
* 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.
2391+
* 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.
23562392
*/
23572393
jobTimeoutMs?: string;
23582394
/**
@@ -2572,7 +2608,7 @@ declare namespace bigquery {
25722608
*/
25732609
schemaInlineFormat?: string;
25742610
/**
2575-
* 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.
2611+
* 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.
25762612
*/
25772613
schemaUpdateOptions?: Array<string>;
25782614
/**
@@ -2694,7 +2730,7 @@ declare namespace bigquery {
26942730
*/
26952731
rangePartitioning?: IRangePartitioning;
26962732
/**
2697-
* 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.
2733+
* 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.
26982734
*/
26992735
schemaUpdateOptions?: Array<string>;
27002736
/**
@@ -3057,6 +3093,10 @@ declare namespace bigquery {
30573093
* Output only. Job cost breakdown as bigquery internal cost and external service costs.
30583094
*/
30593095
externalServiceCosts?: Array<IExternalServiceCost>;
3096+
/**
3097+
* Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
3098+
*/
3099+
incrementalResultStats?: IIncrementalResultStats;
30603100
/**
30613101
* Output only. Statistics for a LOAD query.
30623102
*/
@@ -3159,7 +3199,7 @@ declare namespace bigquery {
31593199
*/
31603200
totalPartitionsProcessed?: string;
31613201
/**
3162-
* 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".
3202+
* 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"`.
31633203
*/
31643204
totalServicesSkuSlotMs?: string;
31653205
/**
@@ -3903,6 +3943,24 @@ declare namespace bigquery {
39033943
projectId?: string;
39043944
};
39053945

3946+
/**
3947+
* The column metadata index pruning statistics.
3948+
*/
3949+
type IPruningStats = {
3950+
/**
3951+
* The number of parallel inputs matched.
3952+
*/
3953+
postCmetaPruningParallelInputCount?: string;
3954+
/**
3955+
* The number of partitions matched.
3956+
*/
3957+
postCmetaPruningPartitionCount?: string;
3958+
/**
3959+
* The number of parallel inputs scanned.
3960+
*/
3961+
preCmetaPruningParallelInputCount?: string;
3962+
};
3963+
39063964
/**
39073965
* Options for a user-defined Python function.
39083966
*/
@@ -4649,6 +4707,10 @@ declare namespace bigquery {
46494707
* Statistics for a search query. Populated as part of JobStatistics2.
46504708
*/
46514709
type ISearchStatistics = {
4710+
/**
4711+
* 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.
4712+
*/
4713+
indexPruningStats?: Array<IIndexPruningStats>;
46524714
/**
46534715
* 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.
46544716
*/
@@ -5565,6 +5627,10 @@ declare namespace bigquery {
55655627
* Free form human-readable reason metadata caching was unused for the job.
55665628
*/
55675629
explanation?: string;
5630+
/**
5631+
* The column metadata index pruning statistics.
5632+
*/
5633+
pruningStats?: IPruningStats;
55685634
/**
55695635
* Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).
55705636
*/
@@ -5838,6 +5904,10 @@ declare namespace bigquery {
58385904
* If true, enable global explanation during training.
58395905
*/
58405906
enableGlobalExplain?: boolean;
5907+
/**
5908+
* The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours.
5909+
*/
5910+
endpointIdleTtl?: string;
58415911
/**
58425912
* Feedback type that specifies which algorithm to run for matrix factorization.
58435913
*/
@@ -6031,6 +6101,10 @@ declare namespace bigquery {
60316101
| 'NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN'
60326102
| 'AVERAGE_RANK'
60336103
>;
6104+
/**
6105+
* The id of a Hugging Face model. For example, `google/gemma-2-2b-it`.
6106+
*/
6107+
huggingFaceModelId?: string;
60346108
/**
60356109
* Include drift when fitting an ARIMA model.
60366110
*/
@@ -6102,6 +6176,10 @@ declare namespace bigquery {
61026176
* Type of loss function used during training run.
61036177
*/
61046178
lossType?: 'LOSS_TYPE_UNSPECIFIED' | 'MEAN_SQUARED_LOSS' | 'MEAN_LOG_LOSS';
6179+
/**
6180+
* The type of the machine used to deploy and serve the model.
6181+
*/
6182+
machineType?: string;
61056183
/**
61066184
* The maximum number of iterations in training. Used only for iterative training algorithms.
61076185
*/
@@ -6110,6 +6188,10 @@ declare namespace bigquery {
61106188
* Maximum number of trials to run in parallel.
61116189
*/
61126190
maxParallelTrials?: string;
6191+
/**
6192+
* The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count.
6193+
*/
6194+
maxReplicaCount?: string;
61136195
/**
61146196
* 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.
61156197
*/
@@ -6126,6 +6208,10 @@ declare namespace bigquery {
61266208
* When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
61276209
*/
61286210
minRelativeProgress?: number;
6211+
/**
6212+
* 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.
6213+
*/
6214+
minReplicaCount?: string;
61296215
/**
61306216
* Minimum split loss for boosted tree models.
61316217
*/
@@ -6138,6 +6224,10 @@ declare namespace bigquery {
61386224
* Minimum sum of instance weight needed in a child for boosted tree models.
61396225
*/
61406226
minTreeChildWeight?: string;
6227+
/**
6228+
* The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`.
6229+
*/
6230+
modelGardenModelName?: string;
61416231
/**
61426232
* The model registry.
61436233
*/
@@ -6189,6 +6279,22 @@ declare namespace bigquery {
61896279
* The solver for PCA.
61906280
*/
61916281
pcaSolver?: 'UNSPECIFIED' | 'FULL' | 'RANDOMIZED' | 'AUTO';
6282+
/**
6283+
* 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.
6284+
*/
6285+
reservationAffinityKey?: string;
6286+
/**
6287+
* Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`.
6288+
*/
6289+
reservationAffinityType?:
6290+
| 'RESERVATION_AFFINITY_TYPE_UNSPECIFIED'
6291+
| 'NO_RESERVATION'
6292+
| 'ANY_RESERVATION'
6293+
| 'SPECIFIC_RESERVATION';
6294+
/**
6295+
* 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.
6296+
*/
6297+
reservationAffinityValues?: Array<string>;
61926298
/**
61936299
* Number of paths for the sampled Shapley explain method.
61946300
*/

0 commit comments

Comments
 (0)