Reservation

com.google.cloud.bigquery.reservation.v1.reservation.Reservation
See theReservation companion object
final case class Reservation(name: String, slotCapacity: Long, ignoreIdleSlots: Boolean, autoscale: Option[Autoscale], concurrency: Long, creationTime: Option[Timestamp], updateTime: Option[Timestamp], multiRegionAuxiliary: Boolean, edition: Edition, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Reservation]

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

Value parameters

autoscale

The configuration parameters for the auto scaling feature. Note this is an alpha feature.

concurrency

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.

creationTime

Output only. Creation time of the reservation.

edition

Edition of the reservation.

ignoreIdleSlots

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.

multiRegionAuxiliary

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

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.

slotCapacity

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.

updateTime

Output only. Last update time of the reservation.

Attributes

Companion
object
Source
Reservation.scala
Graph
Supertypes
trait Updatable[Reservation]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source
Reservation.scala

Attributes

Source
Reservation.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
Reservation.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
Reservation.scala

Attributes

Source
Reservation.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
Reservation.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
Reservation.scala

Attributes

Source
Reservation.scala
def withConcurrency(`__v`: Long): Reservation

Attributes

Source
Reservation.scala

Attributes

Source
Reservation.scala

Attributes

Source
Reservation.scala
def withIgnoreIdleSlots(`__v`: Boolean): Reservation

Attributes

Source
Reservation.scala
def withMultiRegionAuxiliary(`__v`: Boolean): Reservation

Attributes

Source
Reservation.scala
def withName(`__v`: String): Reservation

Attributes

Source
Reservation.scala
def withSlotCapacity(`__v`: Long): Reservation

Attributes

Source
Reservation.scala
def withUnknownFields(`__v`: UnknownFieldSet): Reservation

Attributes

Source
Reservation.scala

Attributes

Source
Reservation.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
Reservation.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: Lens[Reservation, Reservation] => () => Reservation*): A

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala