BigQuery Reservation v1 API - Class Reservation (2.6.0) 

public sealed class Reservation : IMessage<Reservation>, IEquatable<Reservation>, IDeepCloneable<Reservation>, IBufferMessage, IMessage

Reference documentation and code samples for the BigQuery Reservation v1 API class Reservation.

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

Inheritance

object > Reservation

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

Reservation()

public Reservation()

Reservation(Reservation)

public Reservation(Reservation other)
Parameter
Name Description
other Reservation

Properties

Autoscale

public Reservation.Types.Autoscale Autoscale { get; set; }

The configuration parameters for the auto scaling feature.

Property Value
Type Description
ReservationTypesAutoscale

Concurrency

public long Concurrency { get; set; }

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.

Property Value
Type Description
long

CreationTime

public Timestamp CreationTime { get; set; }

Output only. Creation time of the reservation.

Property Value
Type Description
Timestamp

Edition

public Edition Edition { get; set; }

Edition of the reservation.

Property Value
Type Description
Edition

IgnoreIdleSlots

public bool IgnoreIdleSlots { get; set; }

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.

Property Value
Type Description
bool

MultiRegionAuxiliary

public bool MultiRegionAuxiliary { get; set; }

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.

Property Value
Type Description
bool

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

OriginalPrimaryLocation

public string OriginalPrimaryLocation { get; set; }

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.

Property Value
Type Description
string

OriginalPrimaryLocationAsLocationName

public LocationName OriginalPrimaryLocationAsLocationName { get; set; }

LocationName-typed view over the OriginalPrimaryLocation resource name property.

Property Value
Type Description
LocationName

PrimaryLocation

public string PrimaryLocation { get; set; }

Optional. The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.

Property Value
Type Description
string

PrimaryLocationAsLocationName

public LocationName PrimaryLocationAsLocationName { get; set; }

LocationName-typed view over the PrimaryLocation resource name property.

Property Value
Type Description
LocationName

ReservationName

public ReservationName ReservationName { get; set; }

ReservationName-typed view over the Name resource name property.

Property Value
Type Description
ReservationName

SecondaryLocation

public string SecondaryLocation { get; set; }

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).

Property Value
Type Description
string

SecondaryLocationAsLocationName

public LocationName SecondaryLocationAsLocationName { get; set; }

LocationName-typed view over the SecondaryLocation resource name property.

Property Value
Type Description
LocationName

SlotCapacity

public long SlotCapacity { get; set; }

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.

Property Value
Type Description
long

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Last update time of the reservation.

Property Value
Type Description
Timestamp