Class Reservation (1.14.0)

Reservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A reservation is a mechanism used to guarantee slots to users.

Attributes

Name Description
name str
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.
slot_capacity int
Minimum 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. If 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. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
ignore_idle_slots bool
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.
autoscale google.cloud.bigquery_reservation_v1.types.Reservation.Autoscale
The configuration parameters for the auto scaling feature. Note this is an alpha feature.
concurrency int
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.
creation_time google.protobuf.timestamp_pb2.Timestamp
Output only. Creation time of the reservation.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Last update time of the reservation.
multi_region_auxiliary bool
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.
edition google.cloud.bigquery_reservation_v1.types.Edition
Edition of the reservation.

Classes

Autoscale

Autoscale(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Auto scaling settings.