REST Resource: projects.locations.reservations

Resource: Reservation

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

JSON representation 
{
  "name": string,
  "slotCapacity": string,
  "ignoreIdleSlots": boolean,
  "autoscale": {
    object (Autoscale)
  },
  "concurrency": string,
  "creationTime": string,
  "updateTime": string,
  "edition": enum (Edition),
  "primaryLocation": string,
  "secondaryLocation": string,
  "originalPrimaryLocation": string
}
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)

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 ignoreIdleSlots is set to false, or autoscaling is enabled.

If edition is EDITION_UNSPECIFIED and 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.

If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slotCapacity of the reservation and its siblings may exceed the total slotCount 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.
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.
autoscale

object (Autoscale)

The configuration parameters for the auto scaling feature.
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 BigQuery 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".
edition

enum (Edition)

Edition of the reservation.
primaryLocation

string

Optional. The primary location of the reservation. The field is only meaningful for a failover reservation that is used for managed disaster recovery. The field is output only for customers and should not be specified. However, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.
secondaryLocation

string

Optional. The secondary location of the reservation that is used for managed disaster recovery. Customers can set this in create/update reservation calls to create a failover reservation or convert a non-failover reservation to a failover reservation.
originalPrimaryLocation

string

Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.

Autoscale

Auto scaling settings.

JSON representation 
{
  "currentSlots": string,
  "maxSlots": string
}
Fields
currentSlots

string (int64 format)

Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, maxSlots]. Note: after users reduce maxSlots, it may take a while before it can be propagated, so currentSlots may stay in the original value and could be larger than maxSlots for that brief period (less than one minute)
maxSlots

string (int64 format)

Number of slots to be scaled when needed.

Methods

create

 Creates a new reservation resource.

delete

 Deletes a reservation.

failoverReservation

 Fail over a reservation to the secondary location.

get

 Returns information about the reservation.

list

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

patch

 Updates an existing reservation resource.