BigQuery Reservation v1 API - Class Reservation (2.4.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. Note this is an alpha 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 BQ 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

ReservationName

public ReservationName ReservationName { get; set; }

ReservationName-typed view over the Name resource name property.

Property Value
Type Description
ReservationName

SlotCapacity

public long SlotCapacity { get; set; }

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.

Property Value
Type Description
long

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Last update time of the reservation.

Property Value
Type Description
Timestamp