You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html
+9
Original file line number
Diff line number
Diff line change
@@ -119,6 +119,7 @@ <h3>Method Details</h3>
119
119
{ # 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.
120
120
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
121
121
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
122
+
"edition": "A String", # Edition of the capacity commitment.
122
123
"failureStatus": { # 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.
123
124
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
124
125
"details": [ # 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>
149
150
{ # 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.
150
151
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
151
152
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
153
+
"edition": "A String", # Edition of the capacity commitment.
152
154
"failureStatus": { # 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.
153
155
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
154
156
"details": [ # 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>
203
205
{ # 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.
204
206
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
205
207
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
208
+
"edition": "A String", # Edition of the capacity commitment.
206
209
"failureStatus": { # 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.
207
210
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
208
211
"details": [ # 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>
242
245
{ # 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.
243
246
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
244
247
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
248
+
"edition": "A String", # Edition of the capacity commitment.
245
249
"failureStatus": { # 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.
246
250
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
247
251
"details": [ # 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>
303
307
{ # 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.
304
308
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
305
309
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
310
+
"edition": "A String", # Edition of the capacity commitment.
306
311
"failureStatus": { # 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.
307
312
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
308
313
"details": [ # 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>
333
338
{ # 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.
334
339
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
335
340
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
341
+
"edition": "A String", # Edition of the capacity commitment.
336
342
"failureStatus": { # 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.
337
343
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
338
344
"details": [ # 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>
362
368
{ # 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.
363
369
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
364
370
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
371
+
"edition": "A String", # Edition of the capacity commitment.
365
372
"failureStatus": { # 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.
366
373
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
367
374
"details": [ # 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>
405
412
"first": { # 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.
406
413
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
407
414
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
415
+
"edition": "A String", # Edition of the capacity commitment.
408
416
"failureStatus": { # 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.
409
417
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
410
418
"details": [ # 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>
424
432
"second": { # 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.
425
433
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
426
434
"commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
435
+
"edition": "A String", # Edition of the capacity commitment.
427
436
"failureStatus": { # 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.
428
437
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
429
438
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Copy file name to clipboardexpand all lines: docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html
+30
Original file line number
Diff line number
Diff line change
@@ -116,8 +116,13 @@ <h3>Method Details</h3>
116
116
The object takes the form of:
117
117
118
118
{ # A reservation is a mechanism used to guarantee slots to users.
119
+
"autoscale": { # 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. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
120
+
"currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
121
+
"maxSlots": "A String", # Number of slots to be scaled when needed.
122
+
},
119
123
"concurrency": "A String", # 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.
120
124
"creationTime": "A String", # Output only. Creation time of the reservation.
125
+
"edition": "A String", # Edition of the reservation.
121
126
"ignoreIdleSlots": 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.
122
127
"multiRegionAuxiliary": 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's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
123
128
"name": "A String", # 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>
135
140
An object of the form:
136
141
137
142
{ # A reservation is a mechanism used to guarantee slots to users.
143
+
"autoscale": { # 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. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
144
+
"currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
145
+
"maxSlots": "A String", # Number of slots to be scaled when needed.
146
+
},
138
147
"concurrency": "A String", # 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.
139
148
"creationTime": "A String", # Output only. Creation time of the reservation.
149
+
"edition": "A String", # Edition of the reservation.
140
150
"ignoreIdleSlots": 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.
141
151
"multiRegionAuxiliary": 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's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
142
152
"name": "A String", # 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>
178
188
An object of the form:
179
189
180
190
{ # A reservation is a mechanism used to guarantee slots to users.
191
+
"autoscale": { # 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. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
192
+
"currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
193
+
"maxSlots": "A String", # Number of slots to be scaled when needed.
194
+
},
181
195
"concurrency": "A String", # 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.
182
196
"creationTime": "A String", # Output only. Creation time of the reservation.
197
+
"edition": "A String", # Edition of the reservation.
183
198
"ignoreIdleSlots": 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.
184
199
"multiRegionAuxiliary": 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's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
185
200
"name": "A String", # 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>
208
223
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
209
224
"reservations": [ # List of reservations visible to the user.
210
225
{ # A reservation is a mechanism used to guarantee slots to users.
226
+
"autoscale": { # 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. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
227
+
"currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
228
+
"maxSlots": "A String", # Number of slots to be scaled when needed.
229
+
},
211
230
"concurrency": "A String", # 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.
212
231
"creationTime": "A String", # Output only. Creation time of the reservation.
232
+
"edition": "A String", # Edition of the reservation.
213
233
"ignoreIdleSlots": 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.
214
234
"multiRegionAuxiliary": 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's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
215
235
"name": "A String", # 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>
244
264
The object takes the form of:
245
265
246
266
{ # A reservation is a mechanism used to guarantee slots to users.
267
+
"autoscale": { # 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. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
268
+
"currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
269
+
"maxSlots": "A String", # Number of slots to be scaled when needed.
270
+
},
247
271
"concurrency": "A String", # 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.
248
272
"creationTime": "A String", # Output only. Creation time of the reservation.
273
+
"edition": "A String", # Edition of the reservation.
249
274
"ignoreIdleSlots": 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.
250
275
"multiRegionAuxiliary": 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's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
251
276
"name": "A String", # 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>
263
288
An object of the form:
264
289
265
290
{ # A reservation is a mechanism used to guarantee slots to users.
291
+
"autoscale": { # 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. # The configuration parameters for the auto scaling feature. Note this is an alpha feature.
292
+
"currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
293
+
"maxSlots": "A String", # Number of slots to be scaled when needed.
294
+
},
266
295
"concurrency": "A String", # 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.
267
296
"creationTime": "A String", # Output only. Creation time of the reservation.
297
+
"edition": "A String", # Edition of the reservation.
268
298
"ignoreIdleSlots": 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.
269
299
"multiRegionAuxiliary": 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's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
270
300
"name": "A String", # 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.
"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
+
},
878
896
"BiReservation": {
879
897
"description": "Represents a BI Reservation.",
880
898
"id": "BiReservation",
@@ -920,6 +938,18 @@
920
938
"readOnly": true,
921
939
"type": "string"
922
940
},
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
+
},
923
953
"failureStatus": {
924
954
"$ref": "Status",
925
955
"description": "Output only. For FAILED commitment plan, provides the reason of failure.",
@@ -941,14 +971,16 @@
941
971
"FLEX",
942
972
"TRIAL",
943
973
"MONTHLY",
944
-
"ANNUAL"
974
+
"ANNUAL",
975
+
"NONE"
945
976
],
946
977
"enumDescriptions": [
947
978
"Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
948
979
"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.",
949
980
"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.",
950
981
"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."
952
984
],
953
985
"type": "string"
954
986
},
@@ -959,14 +991,16 @@
959
991
"FLEX",
960
992
"TRIAL",
961
993
"MONTHLY",
962
-
"ANNUAL"
994
+
"ANNUAL",
995
+
"NONE"
963
996
],
964
997
"enumDescriptions": [
965
998
"Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.",
966
999
"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.",
967
1000
"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.",
968
1001
"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."
970
1004
],
971
1005
"type": "string"
972
1006
},
@@ -1084,6 +1118,10 @@
1084
1118
"description": "A reservation is a mechanism used to guarantee slots to users.",
1085
1119
"id": "Reservation",
1086
1120
"properties": {
1121
+
"autoscale": {
1122
+
"$ref": "Autoscale",
1123
+
"description": "The configuration parameters for the auto scaling feature. Note this is an alpha feature."
1124
+
},
1087
1125
"concurrency": {
1088
1126
"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.",
1089
1127
"format": "int64",
@@ -1095,6 +1133,18 @@
1095
1133
"readOnly": true,
1096
1134
"type": "string"
1097
1135
},
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
+
},
1098
1148
"ignoreIdleSlots": {
1099
1149
"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.",
0 commit comments