Google BigQuery Reservation V1 Client - Class Reservation (2.0.0-RC1)

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

Namespace

Google \ Cloud \ BigQuery \ Reservation \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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 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.
`↳ 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.
`↳ autoscale`	`Google\Cloud\BigQuery\Reservation\V1\Reservation\Autoscale` The configuration parameters for the auto scaling feature. Note this is an alpha feature.
`↳ concurrency`	`int\|string` 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.
`↳ creation_time`	`Google\Protobuf\Timestamp` Output only. Creation time of the reservation.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Last update time of the reservation.
`↳ 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. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
`↳ edition`	`int` Edition of the reservation.

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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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 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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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.

Returns
Type	Description
`bool`

setIgnoreIdleSlots

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAutoscale

The configuration parameters for the auto scaling feature. Note this is an alpha feature.

Returns
Type	Description
`Google\Cloud\BigQuery\Reservation\V1\Reservation\Autoscale\|null`

hasAutoscale

clearAutoscale

setAutoscale

The configuration parameters for the auto scaling feature. Note this is an alpha feature.

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\Reservation\V1\Reservation\Autoscale`

Returns
Type	Description
`$this`

getConcurrency

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.

Returns
Type	Description
`int\|string`

setConcurrency

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.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getCreationTime

Output only. Creation time of the reservation.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreationTime

clearCreationTime

setCreationTime

Output only. Creation time of the reservation.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Last update time of the reservation.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update time of the reservation.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

Returns
Type	Description
`bool`

setMultiRegionAuxiliary

Applicable only for reservations located within one of the BigQuery multi-regions (US or EU).

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEdition

Edition of the reservation.

Returns
Type	Description
`int`

setEdition

Edition of the reservation.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`