Skip to main content
← back to extensions

@swamp/gcp/bigqueryreservation

v2026.04.23.1

Google Cloud bigqueryreservation infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudbigqueryreservationcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/bigqueryreservation

@swamp/gcp/bigqueryreservation/capacitycommitmentsv2026.04.23.1capacitycommitments.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
edition?enumOptional. Edition of the capacity commitment.
failureStatus?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
plan?enumOptional. Capacity commitment commitment plan.
renewalPlan?enumOptional. The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
slotCount?stringOptional. Number of slots in this commitment.
capacityCommitmentId?stringThe optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
enforceSingleAdminProjectPerOrg?stringIf true, fail the request if another project in the organization has a capacity commitment.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a capacityCommitments
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a capacityCommitments
ArgumentTypeDescription
identifierstringThe name of the capacityCommitments
updateUpdate capacityCommitments attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the capacityCommitments
ArgumentTypeDescription
identifierstringThe name of the capacityCommitments
syncSync capacityCommitments state from GCP
mergemerge
ArgumentTypeDescription
capacityCommitmentId?any
capacityCommitmentIds?any
splitsplit
ArgumentTypeDescription
slotCount?any

Resources

state(infinite)— Capacity commitment is a way to purchase compute capacity for BigQuery jobs (...
@swamp/gcp/bigqueryreservation/reservationgroupsv2026.04.23.1reservationgroups.ts

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_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.
reservationGroupId?stringRequired. The reservation group ID. It 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.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a reservationGroups
getGet a reservationGroups
ArgumentTypeDescription
identifierstringThe name of the reservationGroups
deleteDelete the reservationGroups
ArgumentTypeDescription
identifierstringThe name of the reservationGroups
syncSync reservationGroups state from GCP

Resources

state(infinite)— A reservation group is a container for reservations.
@swamp/gcp/bigqueryreservation/reservationsv2026.04.23.1reservations.ts

Global Arguments

ArgumentTypeDescription
autoscale?objectAuto scaling settings.
concurrency?stringOptional. 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 BigQuery CLI.
edition?enumOptional. Edition of the reservation.
ignoreIdleSlots?booleanOptional. 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.
labels?recordOptional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when you create or update a reservation.
maxSlots?stringOptional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exc
name?stringIdentifier. 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.
replicationStatus?objectDisaster Recovery(DR) replication status of the reservation.
reservationGroup?stringOptional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
scalingMode?enumOptional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
schedulingPolicy?objectThe scheduling policy controls how a reservation's resources are distributed.
secondaryLocation?stringOptional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
slotCapacity?stringOptional. Baseline 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, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number o
reservationId?stringThe reservation ID. It 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.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a reservations
getGet a reservations
ArgumentTypeDescription
identifierstringThe name of the reservations
updateUpdate reservations attributes
deleteDelete the reservations
ArgumentTypeDescription
identifierstringThe name of the reservations
syncSync reservations state from GCP
failover_reservationfailover reservation
ArgumentTypeDescription
failoverMode?any

Resources

state(infinite)— A reservation is a mechanism used to guarantee slots to users.
@swamp/gcp/bigqueryreservation/reservations-assignmentsv2026.04.23.1reservations_assignments.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
assignee?stringOptional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
jobType?enumOptional. Which type of jobs will use the reservation.
principal?stringOptional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMA
schedulingPolicy?objectThe scheduling policy controls how a reservation's resources are distributed.
assignmentId?stringThe optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. Max length is 64 characters.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a assignments
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a assignments
ArgumentTypeDescription
identifierstringThe name of the assignments
updateUpdate assignments attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the assignments
ArgumentTypeDescription
identifierstringThe name of the assignments
syncSync assignments state from GCP
movemove
ArgumentTypeDescription
assignmentId?any
destinationId?any

Resources

state(infinite)— An assignment allows a project to submit jobs of a certain type using slots f...