Skip to content

Commit f366cd5

Browse files
yoshi-automationsofisl
authored andcommitted
feat(bigqueryreservation): update the API
#### bigqueryreservation:v1 The following keys were added: - schemas.Assignment.properties.enableGeminiInBigquery.description - schemas.Assignment.properties.enableGeminiInBigquery.type - schemas.Reservation.properties.labels.additionalProperties.type - schemas.Reservation.properties.labels.description - schemas.Reservation.properties.labels.type - schemas.Reservation.properties.originalPrimaryLocation.readOnly - schemas.Reservation.properties.primaryLocation.readOnly The following keys were changed: - resources.projects.resources.locations.resources.reservations.methods.failoverReservation.description - schemas.Autoscale.properties.currentSlots.description - schemas.CapacityCommitment.properties.edition.enumDescriptions - schemas.Reservation.properties.concurrency.description - schemas.Reservation.properties.edition.enumDescriptions - schemas.Reservation.properties.originalPrimaryLocation.description - schemas.Reservation.properties.primaryLocation.description - schemas.Reservation.properties.secondaryLocation.description - schemas.Reservation.properties.slotCapacity.description
1 parent d18d412 commit f366cd5

File tree

2 files changed

+38
-17
lines changed

2 files changed

+38
-17
lines changed

‎discovery/bigqueryreservation-v1.json

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@
635635
]
636636
},
637637
"failoverReservation": {
638-
"description": "Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.",
638+
"description": "Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.",
639639
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:failoverReservation",
640640
"httpMethod": "POST",
641641
"id": "bigqueryreservation.projects.locations.reservations.failoverReservation",
@@ -935,7 +935,7 @@
935935
}
936936
}
937937
},
938-
"revision": "20240921",
938+
"revision": "20241231",
939939
"rootUrl": "https://bigqueryreservation.googleapis.com/",
940940
"schemas": {
941941
"Assignment": {
@@ -946,6 +946,10 @@
946946
"description": "The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.",
947947
"type": "string"
948948
},
949+
"enableGeminiInBigquery": {
950+
"description": "Optional. This field controls if \"Gemini in BigQuery\" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. \"Gemini in BigQuery\" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to \"Gemini in BigQuery\" features.",
951+
"type": "boolean"
952+
},
949953
"jobType": {
950954
"description": "Which type of jobs will use the reservation.",
951955
"enum": [
@@ -994,7 +998,7 @@
994998
"id": "Autoscale",
995999
"properties": {
9961000
"currentSlots": {
997-
"description": "Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].",
1001+
"description": "Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute)",
9981002
"format": "int64",
9991003
"readOnly": true,
10001004
"type": "string"
@@ -1064,7 +1068,7 @@
10641068
"Default value, which will be treated as ENTERPRISE.",
10651069
"Standard edition.",
10661070
"Enterprise edition.",
1067-
"Enterprise plus edition."
1071+
"Enterprise Plus edition."
10681072
],
10691073
"type": "string"
10701074
},
@@ -1296,7 +1300,7 @@
12961300
"description": "The configuration parameters for the auto scaling feature."
12971301
},
12981302
"concurrency": {
1299-
"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 BQ CLI.",
1303+
"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.",
13001304
"format": "int64",
13011305
"type": "string"
13021306
},
@@ -1318,14 +1322,21 @@
13181322
"Default value, which will be treated as ENTERPRISE.",
13191323
"Standard edition.",
13201324
"Enterprise edition.",
1321-
"Enterprise plus edition."
1325+
"Enterprise Plus edition."
13221326
],
13231327
"type": "string"
13241328
},
13251329
"ignoreIdleSlots": {
13261330
"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.",
13271331
"type": "boolean"
13281332
},
1333+
"labels": {
1334+
"additionalProperties": {
1335+
"type": "string"
1336+
},
1337+
"description": "Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation.",
1338+
"type": "object"
1339+
},
13291340
"multiRegionAuxiliary": {
13301341
"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.",
13311342
"type": "boolean"
@@ -1335,19 +1346,21 @@
13351346
"type": "string"
13361347
},
13371348
"originalPrimaryLocation": {
1338-
"description": "Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.",
1349+
"description": "Output only. The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.",
1350+
"readOnly": true,
13391351
"type": "string"
13401352
},
13411353
"primaryLocation": {
1342-
"description": "Optional. The primary location of the reservation. The field is only meaningful for reservation used for cross region disaster recovery. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.",
1354+
"description": "Output only. The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.",
1355+
"readOnly": true,
13431356
"type": "string"
13441357
},
13451358
"secondaryLocation": {
1346-
"description": "Optional. The secondary location of the reservation which is used for cross region disaster recovery purposes. Customer can set this in create/update reservation calls to create a failover reservation or convert a non-failover reservation to a failover reservation.",
1359+
"description": "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).",
13471360
"type": "string"
13481361
},
13491362
"slotCapacity": {
1350-
"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. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. 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.",
1363+
"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.",
13511364
"format": "int64",
13521365
"type": "string"
13531366
},

‎src/apis/bigqueryreservation/v1.ts

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ export namespace bigqueryreservation_v1 {
132132
* The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
133133
*/
134134
assignee?: string | null;
135+
/**
136+
* Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
137+
*/
138+
enableGeminiInBigquery?: boolean | null;
135139
/**
136140
* Which type of jobs will use the reservation.
137141
*/
@@ -150,7 +154,7 @@ export namespace bigqueryreservation_v1 {
150154
*/
151155
export interface Schema$Autoscale {
152156
/**
153-
* Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
157+
* Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute)
154158
*/
155159
currentSlots?: string | null;
156160
/**
@@ -306,7 +310,7 @@ export namespace bigqueryreservation_v1 {
306310
*/
307311
autoscale?: Schema$Autoscale;
308312
/**
309-
* 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 BQ CLI.
313+
* 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.
310314
*/
311315
concurrency?: string | null;
312316
/**
@@ -321,6 +325,10 @@ export namespace bigqueryreservation_v1 {
321325
* 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.
322326
*/
323327
ignoreIdleSlots?: boolean | null;
328+
/**
329+
* Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation.
330+
*/
331+
labels?: {[key: string]: string} | null;
324332
/**
325333
* 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.
326334
*/
@@ -330,19 +338,19 @@ export namespace bigqueryreservation_v1 {
330338
*/
331339
name?: string | null;
332340
/**
333-
* Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.
341+
* Output only. The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
334342
*/
335343
originalPrimaryLocation?: string | null;
336344
/**
337-
* Optional. The primary location of the reservation. The field is only meaningful for reservation used for cross region disaster recovery. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.
345+
* Output only. The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
338346
*/
339347
primaryLocation?: string | null;
340348
/**
341-
* Optional. The secondary location of the reservation which is used for cross region disaster recovery purposes. Customer can set this in create/update reservation calls to create a failover reservation or convert a non-failover reservation to a failover reservation.
349+
* 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).
342350
*/
343351
secondaryLocation?: string | null;
344352
/**
345-
* 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. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. 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.
353+
* 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.
346354
*/
347355
slotCapacity?: string | null;
348356
/**
@@ -1822,7 +1830,7 @@ export namespace bigqueryreservation_v1 {
18221830
}
18231831

18241832
/**
1825-
* Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.
1833+
* Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.
18261834
*
18271835
* @param params - Parameters for request
18281836
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

0 commit comments

Comments
 (0)