REST Resource: projects.locations.reservations

Stay organized with collections Save and categorize content based on your preferences.

Resource: Reservation

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

JSON representation 
{
  "name": string,
  "slotCapacity": string,
  "ignoreIdleSlots": boolean,
  "concurrency": string,
  "creationTime": string,
  "updateTime": string,
  "multiRegionAuxiliary": boolean
}
Fields
name

string

The resource name of the reservation, e.g., projects/*/locations/*/reservations/team1-prod. The reservationId 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.
slotCapacity

string (int64 format)

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 ignoreIdleSlots is set to false.

If total slotCapacity of the reservation and its siblings exceeds the total slotCount 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 multiRegionAuxiliary flag for more details.
ignoreIdleSlots

boolean

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 slotCapacity field at most.
concurrency

string (int64 format)

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

string (Timestamp format)

Output only. Creation time of the reservation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last update time of the reservation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
multiRegionAuxiliary

boolean

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.

Methods

create

 Creates a new reservation resource.

delete

 Deletes a reservation.

get

 Returns information about the reservation.

list

 Lists all the reservations for the project in the specified location.

patch

 Updates an existing reservation resource.