Skip to content

Commit 41568d3

Browse files
feat(bigqueryreservation): update the API
#### bigqueryreservation:v1 The following keys were added: - schemas.Reservation.properties.multiRegionAuxiliary.deprecated The following keys were changed: - resources.projects.resources.locations.resources.reservations.methods.patch.parameters.name.description - schemas.Autoscale.properties.maxSlots.description - schemas.Reservation.properties.autoscale.description - schemas.Reservation.properties.concurrency.description - schemas.Reservation.properties.edition.description - schemas.Reservation.properties.ignoreIdleSlots.description - schemas.Reservation.properties.name.description - schemas.Reservation.properties.scalingMode.description - schemas.Reservation.properties.slotCapacity.description
1 parent 67f136e commit 41568d3

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

‎discovery/bigqueryreservation-v1.json

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -736,7 +736,7 @@
736736
],
737737
"parameters": {
738738
"name": {
739-
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
739+
"description": "Identifier. The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
740740
"location": "path",
741741
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$",
742742
"required": true,
@@ -935,7 +935,7 @@
935935
}
936936
}
937937
},
938-
"revision": "20250316",
938+
"revision": "20250421",
939939
"rootUrl": "https://bigqueryreservation.googleapis.com/",
940940
"schemas": {
941941
"Assignment": {
@@ -1004,7 +1004,7 @@
10041004
"type": "string"
10051005
},
10061006
"maxSlots": {
1007-
"description": "Number of slots to be scaled when needed.",
1007+
"description": "Optional. Number of slots to be scaled when needed.",
10081008
"format": "int64",
10091009
"type": "string"
10101010
}
@@ -1325,10 +1325,10 @@
13251325
"properties": {
13261326
"autoscale": {
13271327
"$ref": "Autoscale",
1328-
"description": "The configuration parameters for the auto scaling feature."
1328+
"description": "Optional. The configuration parameters for the auto scaling feature."
13291329
},
13301330
"concurrency": {
1331-
"description": "Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI.",
1331+
"description": "Optional. Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI.",
13321332
"format": "int64",
13331333
"type": "string"
13341334
},
@@ -1339,7 +1339,7 @@
13391339
"type": "string"
13401340
},
13411341
"edition": {
1342-
"description": "Edition of the reservation.",
1342+
"description": "Optional. Edition of the reservation.",
13431343
"enum": [
13441344
"EDITION_UNSPECIFIED",
13451345
"STANDARD",
@@ -1355,7 +1355,7 @@
13551355
"type": "string"
13561356
},
13571357
"ignoreIdleSlots": {
1358-
"description": "If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.",
1358+
"description": "Optional. If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.",
13591359
"type": "boolean"
13601360
},
13611361
"labels": {
@@ -1371,11 +1371,12 @@
13711371
"type": "string"
13721372
},
13731373
"multiRegionAuxiliary": {
1374+
"deprecated": true,
13741375
"description": "Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.",
13751376
"type": "boolean"
13761377
},
13771378
"name": {
1378-
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
1379+
"description": "Identifier. The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
13791380
"type": "string"
13801381
},
13811382
"originalPrimaryLocation": {
@@ -1394,7 +1395,7 @@
13941395
"readOnly": true
13951396
},
13961397
"scalingMode": {
1397-
"description": "The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
1398+
"description": "Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
13981399
"enum": [
13991400
"SCALING_MODE_UNSPECIFIED",
14001401
"AUTOSCALE_ONLY",
@@ -1414,7 +1415,7 @@
14141415
"type": "string"
14151416
},
14161417
"slotCapacity": {
1417-
"description": "Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.",
1418+
"description": "Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.",
14181419
"format": "int64",
14191420
"type": "string"
14201421
},

‎src/apis/bigqueryreservation/v1.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ export namespace bigqueryreservation_v1 {
158158
*/
159159
currentSlots?: string | null;
160160
/**
161-
* Number of slots to be scaled when needed.
161+
* Optional. Number of slots to be scaled when needed.
162162
*/
163163
maxSlots?: string | null;
164164
}
@@ -327,23 +327,23 @@ export namespace bigqueryreservation_v1 {
327327
*/
328328
export interface Schema$Reservation {
329329
/**
330-
* The configuration parameters for the auto scaling feature.
330+
* Optional. The configuration parameters for the auto scaling feature.
331331
*/
332332
autoscale?: Schema$Autoscale;
333333
/**
334-
* Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI.
334+
* Optional. Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI.
335335
*/
336336
concurrency?: string | null;
337337
/**
338338
* Output only. Creation time of the reservation.
339339
*/
340340
creationTime?: string | null;
341341
/**
342-
* Edition of the reservation.
342+
* Optional. Edition of the reservation.
343343
*/
344344
edition?: string | null;
345345
/**
346-
* If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
346+
* Optional. If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
347347
*/
348348
ignoreIdleSlots?: boolean | null;
349349
/**
@@ -359,7 +359,7 @@ export namespace bigqueryreservation_v1 {
359359
*/
360360
multiRegionAuxiliary?: boolean | null;
361361
/**
362-
* The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
362+
* Identifier. The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
363363
*/
364364
name?: string | null;
365365
/**
@@ -375,15 +375,15 @@ export namespace bigqueryreservation_v1 {
375375
*/
376376
replicationStatus?: Schema$ReplicationStatus;
377377
/**
378-
* The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
378+
* Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
379379
*/
380380
scalingMode?: string | null;
381381
/**
382382
* Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
383383
*/
384384
secondaryLocation?: string | null;
385385
/**
386-
* Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
386+
* Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
387387
*/
388388
slotCapacity?: string | null;
389389
/**
@@ -2281,7 +2281,7 @@ export namespace bigqueryreservation_v1 {
22812281
export interface Params$Resource$Projects$Locations$Reservations$Patch
22822282
extends StandardParameters {
22832283
/**
2284-
* The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
2284+
* Identifier. The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
22852285
*/
22862286
name?: string;
22872287
/**

0 commit comments

Comments
 (0)