Class Reservation (1.15.0)

Version latest

• 1.15.0 (latest)
• 1.14.1
• 1.13.5
• 1.12.0
• 1.11.3
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.3
• 1.6.3
• 1.5.0
• 1.4.1
• 1.3.1
• 1.2.2
• 1.1.0
• 1.0.1
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.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 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.
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.
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 BigQuery 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.
primary_location	str Optional. The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
secondary_location	str 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).
original_primary_location	str Optional. 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.

Classes

Autoscale

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

Auto scaling settings.