Class: Google::Apis::BigqueryreservationV1::Reservation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigqueryreservation_v1/classes.rb,
lib/google/apis/bigqueryreservation_v1/representations.rb,
lib/google/apis/bigqueryreservation_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Reservation

Returns a new instance of Reservation.



448
449
450
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 448

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#autoscale ⇒ Google::Apis::BigqueryreservationV1::Autoscale

Auto scaling settings. Corresponds to the JSON property autoscale

Returns:



381
382
383
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 381

def autoscale
  @autoscale
end

#concurrency ⇒ Fixnum

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. Corresponds to the JSON property concurrency

Returns:

  • (Fixnum) 


391
392
393
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 391

def concurrency
  @concurrency
end

#creation_time ⇒ String

Output only. Creation time of the reservation. Corresponds to the JSON property creationTime

Returns:

  • (String) 


396
397
398
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 396

def creation_time
  @creation_time
end

#edition ⇒ String

Edition of the reservation. Corresponds to the JSON property edition

Returns:

  • (String) 


401
402
403
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 401

def edition
  @edition
end

#ignore_idle_slots ⇒ Boolean Also known as: ignore_idle_slots?

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. Corresponds to the JSON property ignoreIdleSlots

Returns:

  • (Boolean) 


409
410
411
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 409

def ignore_idle_slots
  @ignore_idle_slots
end

#multi_region_auxiliary ⇒ Boolean Also known as: multi_region_auxiliary?

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. Corresponds to the JSON property multiRegionAuxiliary

Returns:

  • (Boolean) 


420
421
422
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 420

def multi_region_auxiliary
  @multi_region_auxiliary
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


429
430
431
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 429

def name
  @name
end

#slot_capacity ⇒ Fixnum

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. Corresponds to the JSON property slotCapacity

Returns:

  • (Fixnum) 


441
442
443
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 441

def slot_capacity
  @slot_capacity
end

#update_time ⇒ String

Output only. Last update time of the reservation. Corresponds to the JSON property updateTime

Returns:

  • (String) 


446
447
448
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 446

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 453

def update!(**args)
  @autoscale = args[:autoscale] if args.key?(:autoscale)
  @concurrency = args[:concurrency] if args.key?(:concurrency)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @edition = args[:edition] if args.key?(:edition)
  @ignore_idle_slots = args[:ignore_idle_slots] if args.key?(:ignore_idle_slots)
  @multi_region_auxiliary = args[:multi_region_auxiliary] if args.key?(:multi_region_auxiliary)
  @name = args[:name] if args.key?(:name)
  @slot_capacity = args[:slot_capacity] if args.key?(:slot_capacity)
  @update_time = args[:update_time] if args.key?(:update_time)
end