Class Reservation (1.19.0) 

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

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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. 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
Output only. 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
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.
max_slots int
Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline. This field must be set together with the scaling_mode enum value. If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000. If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700. If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null. If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments). Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity>=max_slots. Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature. This field is a member of oneof_ _max_slots.
scaling_mode google.cloud.bigquery_reservation_v1.types.Reservation.ScalingMode
Optional. The scaling mode for the reservation. If the field is present but max_slots is not present.
replication_status google.cloud.bigquery_reservation_v1.types.Reservation.ReplicationStatus
Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.

Classes

Autoscale

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

Auto scaling settings.

ReplicationStatus

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

Disaster Recovery(DR) replication status of the reservation.

ScalingMode

ScalingMode(value)

The scaling mode for the reservation. This enum determines how the reservation scales up and down.

    Please note, in this mode, the ignore_idle_slots field must
    be set to true.
IDLE_SLOTS_ONLY (2):
    The reservation will scale up using only idle slots
    contributed by other reservations or from unassigned
    commitments. If no idle slots are available it will not
    scale up further. If the idle slots which it is using are
    reclaimed by the contributing reservation(s) it may be
    forced to scale down. The max idle slots the reservation can
    be max_slots - baseline capacity. For example, if max_slots
    is 1000, baseline is 200 and customer sets ScalingMode to
    IDLE_SLOTS_ONLY,

    1. if there are 1000 idle slots available in other
       reservations, the reservation will scale up to 1000 slots
       with 200 baseline and 800 idle slots.
    2. if there are 500 idle slots available in other
       reservations, the reservation will scale up to 700 slots
       with 200 baseline and 300 idle slots. Please note, in
       this mode, the reservation might not be able to scale up
       to max_slots.

    Please note, in this mode, the ignore_idle_slots field must
    be set to false.
ALL_SLOTS (3):
    The reservation will scale up using all slots available to
    it. It will use idle slots contributed by other reservations
    or from unassigned commitments first. If no idle slots are
    available it will scale up using autoscaling. For example,
    if max_slots is 1000, baseline is 200 and customer sets
    ScalingMode to ALL_SLOTS,

    1. if there are 800 idle slots available in other
       reservations, the reservation will scale up to 1000 slots
       with 200 baseline and 800 idle slots.
    2. if there are 500 idle slots available in other
       reservations, the reservation will scale up to 1000 slots
       with 200 baseline, 500 idle slots and 300 autoscaling
       slots.
    3. if there are no idle slots available in other
       reservations, it will scale up to 1000 slots with 200
       baseline and 800 autoscaling slots.

    Please note, in this mode, the ignore_idle_slots field must
    be set to false.