Reference documentation and code samples for the Google BigQuery Reservation V1 Client class Reservation.
A reservation is a mechanism used to guarantee slots to users.
Generated from protobuf message google.cloud.bigquery.reservation.v1.Reservation
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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|string
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 the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, 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.
↳ 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.
↳ concurrency
int|string
Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
↳ creation_time
↳ update_time
↳ 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.
getName
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.
string
setName
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.
var
string
$this
getSlotCapacity
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 the new reservation's slot capacity exceeds the project's slot capacity
or if total slot capacity of the new reservation and its siblings exceeds
the project's slot capacity, 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.
int|string
setSlotCapacity
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 the new reservation's slot capacity exceeds the project's slot capacity
or if total slot capacity of the new reservation and its siblings exceeds
the project's slot capacity, 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.
var
int|string
$this
getIgnoreIdleSlots
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.
bool
setIgnoreIdleSlots
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.
var
bool
$this
getConcurrency
Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries.
Default value is 0 which means that concurrency will be automatically set based on the reservation size.
int|string
setConcurrency
Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries.
Default value is 0 which means that concurrency will be automatically set based on the reservation size.
var
int|string
$this
getCreationTime
Output only. Creation time of the reservation.
hasCreationTime
clearCreationTime
setCreationTime
Output only. Creation time of the reservation.
$this
getUpdateTime
Output only. Last update time of the reservation.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update time of the reservation.
$this
getMultiRegionAuxiliary
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.
bool
setMultiRegionAuxiliary
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.
var
bool
$this
