Reference documentation and code samples for the BigQuery Reservation API module Google::Cloud::Bigquery::Reservation.
Methods
.configure
def self.configure() -> ::Google::Cloud::Config
Configure the google-cloud-bigquery-reservation library.
The following configuration parameters are supported:
credentials
(type:String, Hash, Google::Auth::Credentials
) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.lib_name
(type:String
) - The library name as recorded in instrumentation and logging.lib_version
(type:String
) - The library version as recorded in instrumentation and logging.interceptors
(type:Array<GRPC::ClientInterceptor>
) - An array of interceptors that are run before calls are executed.timeout
(type:Numeric
) - Default timeout in seconds.metadata
(type:Hash{Symbol=>String}
) - Additional gRPC headers to be sent with the call.retry_policy
(type:Hash
) - The retry policy. The value is a hash with the following keys::initial_delay
(type:Numeric
) - The initial delay in seconds.:max_delay
(type:Numeric
) - The max delay in seconds.:multiplier
(type:Numeric
) - The incremental backoff multiplier.:retry_codes
(type:Array<String>
) - The error codes that should trigger a retry.
- (::Google::Cloud.configure.bigquery_reservation)
- (::Google::Cloud::Config) — The default configuration used by this library
.reservation_service
def self.reservation_service(version: :v1, &block) -> ReservationService::Client
Create a new client object for ReservationService.
By default, this returns an instance of
Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client
for version V1 of the API.
However, you can specify specify a different API version by passing it in the
version
parameter. If the ReservationService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
About ReservationService
This API allows users to manage their flat-rate BigQuery reservations.
A reservation provides computational resource guarantees, in the form of
slots, to users. A slot is a
unit of computational power in BigQuery, and serves as the basic unit of
parallelism. In a scan of a multi-partitioned table, a single slot operates
on a single partition of the table. A reservation resource exists as a child
resource of the admin project and location, e.g.:
projects/myproject/locations/US/reservations/reservationName
.
A capacity commitment is a way to purchase compute capacity for BigQuery jobs
(in the form of slots) with some committed period of usage. A capacity
commitment resource exists as a child resource of the admin project and
location, e.g.:
projects/myproject/locations/US/capacityCommitments/id
.
-
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to
:v1
.
- (ReservationService::Client) — A client object for the specified version.
Constants
VERSION
value: "1.1.3"