BigQuery Reservation API

Stay organized with collections Save and categorize content based on your preferences.

A service to modify your BigQuery flat-rate reservations.

Service: bigqueryreservation.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://bigqueryreservation.googleapis.com

REST Resource: v1.projects.locations

Methods
getBiReservation GET /v1/{name=projects/*/locations/*/biReservation}
Retrieves a BI reservation.
searchAllAssignments GET /v1/{parent=projects/*/locations/*}:searchAllAssignments
Looks up assignments for a specified resource for a particular region.
searchAssignments
(deprecated)		 GET /v1/{parent=projects/*/locations/*}:searchAssignments
Deprecated: Looks up assignments for a specified resource for a particular region.
updateBiReservation PATCH /v1/{biReservation.name=projects/*/locations/*/biReservation}
Updates a BI reservation.

REST Resource: v1.projects.locations.capacityCommitments

Methods
create POST /v1/{parent=projects/*/locations/*}/capacityCommitments
Creates a new capacity commitment resource.
delete DELETE /v1/{name=projects/*/locations/*/capacityCommitments/*}
Deletes a capacity commitment.
get GET /v1/{name=projects/*/locations/*/capacityCommitments/*}
Returns information about the capacity commitment.
list GET /v1/{parent=projects/*/locations/*}/capacityCommitments
Lists all the capacity commitments for the admin project.
merge POST /v1/{parent=projects/*/locations/*}/capacityCommitments:merge
Merges capacity commitments of the same plan into a single commitment.
patch PATCH /v1/{capacityCommitment.name=projects/*/locations/*/capacityCommitments/*}
Updates an existing capacity commitment.
split POST /v1/{name=projects/*/locations/*/capacityCommitments/*}:split
Splits capacity commitment to two commitments of the same plan and commitment_end_time.

REST Resource: v1.projects.locations.reservations

Methods
create POST /v1/{parent=projects/*/locations/*}/reservations
Creates a new reservation resource.
delete DELETE /v1/{name=projects/*/locations/*/reservations/*}
Deletes a reservation.
get GET /v1/{name=projects/*/locations/*/reservations/*}
Returns information about the reservation.
list GET /v1/{parent=projects/*/locations/*}/reservations
Lists all the reservations for the project in the specified location.
patch PATCH /v1/{reservation.name=projects/*/locations/*/reservations/*}
Updates an existing reservation resource.

REST Resource: v1.projects.locations.reservations.assignments

Methods
create POST /v1/{parent=projects/*/locations/*/reservations/*}/assignments
Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.
delete DELETE /v1/{name=projects/*/locations/*/reservations/*/assignments/*}
Deletes a assignment.
list GET /v1/{parent=projects/*/locations/*/reservations/*}/assignments
Lists assignments.
move POST /v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move
Moves an assignment under a new reservation.
patch PATCH /v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}
Updates an existing assignment.