Reference documentation and code samples for the BigQuery Reservation V1 API class Google::Cloud::Bigquery::Reservation::V1::Reservation.
A reservation is a mechanism used to guarantee slots to users.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#autoscale
def autoscale() -> ::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale
- (::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale) — The configuration parameters for the auto scaling feature. Note this is an alpha feature.
#autoscale=
def autoscale=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale
- value (::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale) — The configuration parameters for the auto scaling feature. Note this is an alpha feature.
- (::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale) — The configuration parameters for the auto scaling feature. Note this is an alpha feature.
#concurrency
def concurrency() -> ::Integer
-
(::Integer) — 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.
#concurrency=
def concurrency=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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
def creation_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Creation time of the reservation.
#edition
def edition() -> ::Google::Cloud::Bigquery::Reservation::V1::Edition
- (::Google::Cloud::Bigquery::Reservation::V1::Edition) — Edition of the reservation.
#edition=
def edition=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::Edition
- value (::Google::Cloud::Bigquery::Reservation::V1::Edition) — Edition of the reservation.
- (::Google::Cloud::Bigquery::Reservation::V1::Edition) — Edition of the reservation.
#ignore_idle_slots
def ignore_idle_slots() -> ::Boolean
- (::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 slot_capacity field at most.
#ignore_idle_slots=
def ignore_idle_slots=(value) -> ::Boolean
- value (::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 slot_capacity field at most.
- (::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 slot_capacity field at most.
#multi_region_auxiliary
def multi_region_auxiliary() -> ::Boolean
-
(::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.
#multi_region_auxiliary=
def multi_region_auxiliary=(value) -> ::Boolean
-
value (::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.
-
(::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.
#name
def name() -> ::String
-
(::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.
#name=
def name=(value) -> ::String
-
value (::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.
-
(::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
def slot_capacity() -> ::Integer
-
(::Integer) — 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.
#slot_capacity=
def slot_capacity=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Last update time of the reservation.