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.



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

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

Instance Attribute Details

#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) 


345
346
347
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 345

def concurrency
  @concurrency
end

#creation_time ⇒ String

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

Returns:

  • (String) 


350
351
352
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 350

def creation_time
  @creation_time
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) 


358
359
360
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 358

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

Returns:

  • (Boolean) 


368
369
370
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 368

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) 


377
378
379
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 377

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) 


389
390
391
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 389

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) 


394
395
396
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 394

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



401
402
403
404
405
406
407
408
409
 
# File 'lib/google/apis/bigqueryreservation_v1/classes.rb', line 401

def update!(**args)
  @concurrency = args[:concurrency] if args.key?(:concurrency)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @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