Class: Google::Apis::BigqueryreservationV1alpha2::Reservation

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Reservation

Returns a new instance of Reservation.


236
237
238
# File 'generated/google/apis/bigqueryreservation_v1alpha2/classes.rb', line 236

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

Instance Attribute Details

#nameString

The resource name of the reservation, e.g., "projects//locations// reservations/dev/team/product". Reservation names (e.g., "dev/team/product") exceeding a depth of six will fail with google.rpc.Code.INVALID_ARGUMENT. Corresponds to the JSON property name

Returns:

  • (String)

211
212
213
# File 'generated/google/apis/bigqueryreservation_v1alpha2/classes.rb', line 211

def name
  @name
end

#slot_capacityFixnum

Maximum slots available to this reservation and its children. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. Corresponds to the JSON property slotCapacity

Returns:

  • (Fixnum)

222
223
224
# File 'generated/google/apis/bigqueryreservation_v1alpha2/classes.rb', line 222

def slot_capacity
  @slot_capacity
end

#use_parent_reservationBoolean Also known as: use_parent_reservation?

If true, any query using this reservation will also be submitted to the parent reservation. This allows the query to share the additional slot capacity of the parent with other queries in the parent reservation. If the parent also has this field set to true, then this process will continue until it encounters a reservation for which this is false. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. Ignored for top-level reservation. Corresponds to the JSON property useParentReservation

Returns:

  • (Boolean)

233
234
235
# File 'generated/google/apis/bigqueryreservation_v1alpha2/classes.rb', line 233

def use_parent_reservation
  @use_parent_reservation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


241
242
243
244
245
# File 'generated/google/apis/bigqueryreservation_v1alpha2/classes.rb', line 241

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @slot_capacity = args[:slot_capacity] if args.key?(:slot_capacity)
  @use_parent_reservation = args[:use_parent_reservation] if args.key?(:use_parent_reservation)
end