Classes
Assignment
An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Assignment.Types
Container for nested types declared in the Assignment message type.
AssignmentName
Resource name for the Assignment resource.
BiReservation
Represents a BI Reservation.
BiReservationName
Resource name for the BiReservation resource.
CapacityCommitment
Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes.
In order to remove annual commitment, its plan needs to be changed to monthly or flex first.
A capacity commitment resource exists as a child resource of the admin project.
CapacityCommitment.Types
Container for nested types declared in the CapacityCommitment message type.
CapacityCommitmentName
Resource name for the CapacityCommitment resource.
CreateAssignmentRequest
The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. Note: "bigquery.reservationAssignments.create" permission is required on the related assignee.
CreateCapacityCommitmentRequest
The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].
CreateReservationRequest
The request for [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].
DeleteAssignmentRequest
The request for [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee.
DeleteCapacityCommitmentRequest
The request for [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].
DeleteReservationRequest
The request for [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].
GetBiReservationRequest
A request to get a singleton BI reservation.
GetCapacityCommitmentRequest
The request for [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].
GetReservationRequest
The request for [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].
ListAssignmentsRequest
The request for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].
ListAssignmentsResponse
The response for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].
ListCapacityCommitmentsRequest
The request for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].
ListCapacityCommitmentsResponse
The response for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].
ListReservationsRequest
The request for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].
ListReservationsResponse
The response for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].
MergeCapacityCommitmentsRequest
The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].
MoveAssignmentRequest
The request for [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].
Note: "bigquery.reservationAssignments.create" permission is required on the destination_id.
Note: "bigquery.reservationAssignments.create" and "bigquery.reservationAssignments.delete" permission are required on the related assignee.
Reservation
A reservation is a mechanism used to guarantee slots to users.
Reservation.Types
Container for nested types declared in the Reservation message type.
Reservation.Types.Autoscale
Auto scaling settings.
ReservationName
Resource name for the Reservation resource.
ReservationService
This API allows users to manage their BigQuery reservations.
A reservation provides computational resource guarantees, in the form of
slots, to users. A slot is a
unit of computational power in BigQuery, and serves as the basic unit of
parallelism. In a scan of a multi-partitioned table, a single slot operates
on a single partition of the table. A reservation resource exists as a child
resource of the admin project and location, e.g.:
projects/myproject/locations/US/reservations/reservationName.
A capacity commitment is a way to purchase compute capacity for BigQuery jobs
(in the form of slots) with some committed period of usage. A capacity
commitment resource exists as a child resource of the admin project and
location, e.g.:
projects/myproject/locations/US/capacityCommitments/id.
ReservationService.ReservationServiceBase
Base class for server-side implementations of ReservationService
ReservationService.ReservationServiceClient
Client for ReservationService
ReservationServiceClient
ReservationService client wrapper, for convenient use.
ReservationServiceClientBuilder
Builder class for ReservationServiceClient to provide simple configuration of credentials, endpoint etc.
ReservationServiceClientImpl
ReservationService client wrapper implementation, for convenient use.
ReservationServiceSettings
Settings for ReservationServiceClient instances.
SearchAllAssignmentsRequest
The request for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.
SearchAllAssignmentsResponse
The response for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].
SearchAssignmentsRequest
The request for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.
SearchAssignmentsResponse
The response for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].
SplitCapacityCommitmentRequest
The request for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].
SplitCapacityCommitmentResponse
The response for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].
TableReference
Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.
UpdateAssignmentRequest
The request for [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].
UpdateBiReservationRequest
A request to update a BI reservation.
UpdateCapacityCommitmentRequest
The request for [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].
UpdateReservationRequest
The request for [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].
Enums
Assignment.Types.JobType
Types of job, which could be specified when using the reservation.
Assignment.Types.State
Assignment will remain in PENDING state if no active capacity commitment is present. It will become ACTIVE when some capacity commitment becomes active.
AssignmentName.ResourceNameType
The possible contents of AssignmentName.
BiReservationName.ResourceNameType
The possible contents of BiReservationName.
CapacityCommitment.Types.CommitmentPlan
Commitment plan defines the current committed period. Capacity commitment cannot be deleted during it's committed period.
CapacityCommitment.Types.State
Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE or FAILED.
CapacityCommitmentName.ResourceNameType
The possible contents of CapacityCommitmentName.
Edition
The type of editions. Different features and behaviors are provided to different editions Capacity commitments and reservations are linked to editions.
ReservationName.ResourceNameType
The possible contents of ReservationName.