Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 58e8139

Browse files
committedJan 31, 2023
feat(bigqueryreservation): update the api
#### bigqueryreservation:v1 The following keys were added: - schemas.Autoscale (Total Keys: 7) - schemas.CapacityCommitment.properties.edition.type (Total Keys: 1) - schemas.Reservation.properties.autoscale.$ref (Total Keys: 1) - schemas.Reservation.properties.edition.type (Total Keys: 1)
1 parent 0157ea5 commit 58e8139

3 files changed

+94
-5
lines changed
 

‎docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html

+9
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ <h3>Method Details</h3>
119119
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
120120
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
121121
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
122+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
122123
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
123124
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
124125
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -149,6 +150,7 @@ <h3>Method Details</h3>
149150
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
150151
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
151152
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
153+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
152154
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
153155
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
154156
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -203,6 +205,7 @@ <h3>Method Details</h3>
203205
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
204206
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
205207
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
208+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
206209
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
207210
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
208211
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -242,6 +245,7 @@ <h3>Method Details</h3>
242245
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
243246
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
244247
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
248+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
245249
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
246250
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
247251
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -303,6 +307,7 @@ <h3>Method Details</h3>
303307
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
304308
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
305309
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
310+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
306311
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
307312
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
308313
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -333,6 +338,7 @@ <h3>Method Details</h3>
333338
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
334339
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
335340
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
341+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
336342
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
337343
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
338344
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -362,6 +368,7 @@ <h3>Method Details</h3>
362368
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
363369
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
364370
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
371+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
365372
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
366373
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
367374
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -405,6 +412,7 @@ <h3>Method Details</h3>
405412
&quot;first&quot;: { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. # First capacity commitment, result of a split.
406413
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
407414
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
415+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
408416
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
409417
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
410418
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -424,6 +432,7 @@ <h3>Method Details</h3>
424432
&quot;second&quot;: { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. # Second capacity commitment, result of a split.
425433
&quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
426434
&quot;commitmentStartTime&quot;: &quot;A String&quot;, # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
435+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the capacity commitment.
427436
&quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED commitment plan, provides the reason of failure.
428437
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
429438
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

‎docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html

+30
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,13 @@ <h3>Method Details</h3>
116116
The object takes the form of:
117117

118118
{ # A reservation is a mechanism used to guarantee slots to users.
119+
&quot;autoscale&quot;: { # Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won&#x27;t be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won&#x27;t be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
120+
&quot;currentSlots&quot;: &quot;A String&quot;, # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
121+
&quot;maxSlots&quot;: &quot;A String&quot;, # Number of slots to be scaled when needed.
122+
},
119123
&quot;concurrency&quot;: &quot;A String&quot;, # 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.
120124
&quot;creationTime&quot;: &quot;A String&quot;, # Output only. Creation time of the reservation.
125+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the reservation.
121126
&quot;ignoreIdleSlots&quot;: True or False, # 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.
122127
&quot;multiRegionAuxiliary&quot;: True or False, # 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&#x27;s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization&#x27;s default region.
123128
&quot;name&quot;: &quot;A String&quot;, # 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.
@@ -135,8 +140,13 @@ <h3>Method Details</h3>
135140
An object of the form:
136141

137142
{ # A reservation is a mechanism used to guarantee slots to users.
143+
&quot;autoscale&quot;: { # Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won&#x27;t be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won&#x27;t be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
144+
&quot;currentSlots&quot;: &quot;A String&quot;, # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
145+
&quot;maxSlots&quot;: &quot;A String&quot;, # Number of slots to be scaled when needed.
146+
},
138147
&quot;concurrency&quot;: &quot;A String&quot;, # 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.
139148
&quot;creationTime&quot;: &quot;A String&quot;, # Output only. Creation time of the reservation.
149+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the reservation.
140150
&quot;ignoreIdleSlots&quot;: True or False, # 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.
141151
&quot;multiRegionAuxiliary&quot;: True or False, # 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&#x27;s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization&#x27;s default region.
142152
&quot;name&quot;: &quot;A String&quot;, # 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.
@@ -178,8 +188,13 @@ <h3>Method Details</h3>
178188
An object of the form:
179189

180190
{ # A reservation is a mechanism used to guarantee slots to users.
191+
&quot;autoscale&quot;: { # Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won&#x27;t be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won&#x27;t be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
192+
&quot;currentSlots&quot;: &quot;A String&quot;, # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
193+
&quot;maxSlots&quot;: &quot;A String&quot;, # Number of slots to be scaled when needed.
194+
},
181195
&quot;concurrency&quot;: &quot;A String&quot;, # 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.
182196
&quot;creationTime&quot;: &quot;A String&quot;, # Output only. Creation time of the reservation.
197+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the reservation.
183198
&quot;ignoreIdleSlots&quot;: True or False, # 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.
184199
&quot;multiRegionAuxiliary&quot;: True or False, # 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&#x27;s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization&#x27;s default region.
185200
&quot;name&quot;: &quot;A String&quot;, # 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.
@@ -208,8 +223,13 @@ <h3>Method Details</h3>
208223
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
209224
&quot;reservations&quot;: [ # List of reservations visible to the user.
210225
{ # A reservation is a mechanism used to guarantee slots to users.
226+
&quot;autoscale&quot;: { # Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won&#x27;t be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won&#x27;t be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
227+
&quot;currentSlots&quot;: &quot;A String&quot;, # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
228+
&quot;maxSlots&quot;: &quot;A String&quot;, # Number of slots to be scaled when needed.
229+
},
211230
&quot;concurrency&quot;: &quot;A String&quot;, # 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.
212231
&quot;creationTime&quot;: &quot;A String&quot;, # Output only. Creation time of the reservation.
232+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the reservation.
213233
&quot;ignoreIdleSlots&quot;: True or False, # 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.
214234
&quot;multiRegionAuxiliary&quot;: True or False, # 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&#x27;s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization&#x27;s default region.
215235
&quot;name&quot;: &quot;A String&quot;, # 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.
@@ -244,8 +264,13 @@ <h3>Method Details</h3>
244264
The object takes the form of:
245265

246266
{ # A reservation is a mechanism used to guarantee slots to users.
267+
&quot;autoscale&quot;: { # Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won&#x27;t be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won&#x27;t be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
268+
&quot;currentSlots&quot;: &quot;A String&quot;, # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
269+
&quot;maxSlots&quot;: &quot;A String&quot;, # Number of slots to be scaled when needed.
270+
},
247271
&quot;concurrency&quot;: &quot;A String&quot;, # 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.
248272
&quot;creationTime&quot;: &quot;A String&quot;, # Output only. Creation time of the reservation.
273+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the reservation.
249274
&quot;ignoreIdleSlots&quot;: True or False, # 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.
250275
&quot;multiRegionAuxiliary&quot;: True or False, # 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&#x27;s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization&#x27;s default region.
251276
&quot;name&quot;: &quot;A String&quot;, # 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.
@@ -263,8 +288,13 @@ <h3>Method Details</h3>
263288
An object of the form:
264289

265290
{ # A reservation is a mechanism used to guarantee slots to users.
291+
&quot;autoscale&quot;: { # Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won&#x27;t be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won&#x27;t be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
292+
&quot;currentSlots&quot;: &quot;A String&quot;, # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
293+
&quot;maxSlots&quot;: &quot;A String&quot;, # Number of slots to be scaled when needed.
294+
},
266295
&quot;concurrency&quot;: &quot;A String&quot;, # 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.
267296
&quot;creationTime&quot;: &quot;A String&quot;, # Output only. Creation time of the reservation.
297+
&quot;edition&quot;: &quot;A String&quot;, # Edition of the reservation.
268298
&quot;ignoreIdleSlots&quot;: True or False, # 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.
269299
&quot;multiRegionAuxiliary&quot;: True or False, # 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&#x27;s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization&#x27;s default region.
270300
&quot;name&quot;: &quot;A String&quot;, # 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.

‎googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json

+55-5
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,7 @@
823823
}
824824
}
825825
},
826-
"revision": "20230117",
826+
"revision": "20230121",
827827
"rootUrl": "https://bigqueryreservation.googleapis.com/",
828828
"schemas": {
829829
"Assignment": {
@@ -875,6 +875,24 @@
875875
},
876876
"type": "object"
877877
},
878+
"Autoscale": {
879+
"description": "Auto scaling settings. max_slots and budget are mutually exclusive. If max_slots is set: * The system will create a dedicated `FLEX` capacity commitment to hold the slots for auto-scale. Users won't be able to manage it, to avoid conflicts. * Scale-up will happen if there are always pending tasks for the past 10 minutes. * Scale-down will happen, if the system detects that scale-up won't be triggered again. If budget is set: * The system will try to use more slots immediately. * At a particular moment, the number of slots scaled is determined by the sytsem, based on the remaining budget and system limit. But overall the usage will conform to the budget if there is enough traffic. * The system will round the slot usage every minute. **Note** this is an alpha feature.",
880+
"id": "Autoscale",
881+
"properties": {
882+
"currentSlots": {
883+
"description": "Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].",
884+
"format": "int64",
885+
"readOnly": true,
886+
"type": "string"
887+
},
888+
"maxSlots": {
889+
"description": "Number of slots to be scaled when needed.",
890+
"format": "int64",
891+
"type": "string"
892+
}
893+
},
894+
"type": "object"
895+
},
878896
"BiReservation": {
879897
"description": "Represents a BI Reservation.",
880898
"id": "BiReservation",
@@ -920,6 +938,18 @@
920938
"readOnly": true,
921939
"type": "string"
922940
},
941+
"edition": {
942+
"description": "Edition of the capacity commitment.",
943+
"enum": [
944+
"EDITION_UNSPECIFIED",
945+
"ENTERPRISE"
946+
],
947+
"enumDescriptions": [
948+
"Default value, only for legacy reservations and capacity commitments.",
949+
"Enterprise edition."
950+
],
951+
"type": "string"
952+
},
923953
"failureStatus": {
924954
"$ref": "Status",
925955
"description": "Output only. For FAILED commitment plan, provides the reason of failure.",
@@ -941,14 +971,16 @@
941971
"FLEX",
942972
"TRIAL",
943973
"MONTHLY",
944-
"ANNUAL"
974+
"ANNUAL",
975+
"NONE"
945976
],
946977
"enumDescriptions": [
947978
"Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
948979
"Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.",
949980
"Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so that it can be deleted right after committed period ends.",
950981
"Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.",
951-
"Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan."
982+
"Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.",
983+
"Should only be used for `renewal_plan` and is only meaningful if edition is specified to values other than EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or UpdateCapacityCommitmentRequest will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. If the renewal_plan is NONE, capacity commitment will be removed at the end of its commitment period."
952984
],
953985
"type": "string"
954986
},
@@ -959,14 +991,16 @@
959991
"FLEX",
960992
"TRIAL",
961993
"MONTHLY",
962-
"ANNUAL"
994+
"ANNUAL",
995+
"NONE"
963996
],
964997
"enumDescriptions": [
965998
"Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
966999
"Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.",
9671000
"Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so that it can be deleted right after committed period ends.",
9681001
"Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.",
969-
"Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan."
1002+
"Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.",
1003+
"Should only be used for `renewal_plan` and is only meaningful if edition is specified to values other than EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or UpdateCapacityCommitmentRequest will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. If the renewal_plan is NONE, capacity commitment will be removed at the end of its commitment period."
9701004
],
9711005
"type": "string"
9721006
},
@@ -1084,6 +1118,10 @@
10841118
"description": "A reservation is a mechanism used to guarantee slots to users.",
10851119
"id": "Reservation",
10861120
"properties": {
1121+
"autoscale": {
1122+
"$ref": "Autoscale",
1123+
"description": "The configuration parameters for the auto scaling feature. Note this is an alpha feature."
1124+
},
10871125
"concurrency": {
10881126
"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.",
10891127
"format": "int64",
@@ -1095,6 +1133,18 @@
10951133
"readOnly": true,
10961134
"type": "string"
10971135
},
1136+
"edition": {
1137+
"description": "Edition of the reservation.",
1138+
"enum": [
1139+
"EDITION_UNSPECIFIED",
1140+
"ENTERPRISE"
1141+
],
1142+
"enumDescriptions": [
1143+
"Default value, only for legacy reservations and capacity commitments.",
1144+
"Enterprise edition."
1145+
],
1146+
"type": "string"
1147+
},
10981148
"ignoreIdleSlots": {
10991149
"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.",
11001150
"type": "boolean"

0 commit comments

Comments
 (0)
Please sign in to comment.