Package google.cloud.bigquery.reservation.v1

Index

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.

CreateAssignment

rpc CreateAssignment(CreateAssignmentRequest) returns (Assignment)

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.

Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type.

Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query.

When creating assignments, it does not matter if other assignments exist at higher levels.

Example:

  • The organization organizationA contains two projects, project1 and project2.
  • Assignments for all three entities (organizationA, project1, and project2) could all be created and mapped to the same or different reservations.

"None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: projects/myproject/locations/US/reservations/none.

Returns google.rpc.Code.PERMISSION_DENIED if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation.

Returns google.rpc.Code.INVALID_ARGUMENT when location of the assignment does not match location of the reservation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateCapacityCommitment

rpc CreateCapacityCommitment(CreateCapacityCommitmentRequest) returns (CapacityCommitment)

Creates a new capacity commitment resource.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateReservation

rpc CreateReservation(CreateReservationRequest) returns (Reservation)

Creates a new reservation resource.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteAssignment

rpc DeleteAssignment(DeleteAssignmentRequest) returns (Empty)

Deletes a assignment. No expansion will happen.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, deletion of the <organizationA, res1> assignment won't affect the other assignment <project1, res1>. After said deletion, queries from project1 will still use res1 while queries from project2 will switch to use on-demand mode.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteCapacityCommitment

rpc DeleteCapacityCommitment(DeleteCapacityCommitmentRequest) returns (Empty)

Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteReservation

rpc DeleteReservation(DeleteReservationRequest) returns (Empty)

Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
FailoverReservation

rpc FailoverReservation(FailoverReservationRequest) returns (Reservation)

Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetBiReservation

rpc GetBiReservation(GetBiReservationRequest) returns (BiReservation)

Retrieves a BI reservation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetCapacityCommitment

rpc GetCapacityCommitment(GetCapacityCommitmentRequest) returns (CapacityCommitment)

Returns information about the capacity commitment.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetReservation

rpc GetReservation(GetReservationRequest) returns (Reservation)

Returns information about the reservation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListAssignments

rpc ListAssignments(ListAssignmentsRequest) returns (ListAssignmentsResponse)

Lists assignments.

Only explicitly created assignments will be returned.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, ListAssignments will just return the above two assignments for reservation res1, and no expansion/merge will happen.

The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed.

Note "-" cannot be used for projects nor locations.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListCapacityCommitments

rpc ListCapacityCommitments(ListCapacityCommitmentsRequest) returns (ListCapacityCommitmentsResponse)

Lists all the capacity commitments for the admin project.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListReservations

rpc ListReservations(ListReservationsRequest) returns (ListReservationsResponse)

Lists all the reservations for the project in the specified location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
MergeCapacityCommitments

rpc MergeCapacityCommitments(MergeCapacityCommitmentsRequest) returns (CapacityCommitment)

Merges capacity commitments of the same plan into a single commitment.

The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments.

Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
MoveAssignment

rpc MoveAssignment(MoveAssignmentRequest) returns (Assignment)

Moves an assignment under a new reservation.

This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
SearchAllAssignments

rpc SearchAllAssignments(SearchAllAssignmentsRequest) returns (SearchAllAssignmentsResponse)

Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.
Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
SearchAssignments

rpc SearchAssignments(SearchAssignmentsRequest) returns (SearchAssignmentsResponse)

Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.

Note "-" cannot be used for projects nor locations.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
SplitCapacityCommitment

rpc SplitCapacityCommitment(SplitCapacityCommitmentRequest) returns (SplitCapacityCommitmentResponse)

Splits capacity commitment to two commitments of the same plan and commitment_end_time.

A common use case is to enable downgrading commitments.

For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateAssignment

rpc UpdateAssignment(UpdateAssignmentRequest) returns (Assignment)

Updates an existing assignment.

Only the priority field can be updated.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateBiReservation

rpc UpdateBiReservation(UpdateBiReservationRequest) returns (BiReservation)

Updates a BI reservation.

Only fields specified in the field_mask are updated.

A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateCapacityCommitment

rpc UpdateCapacityCommitment(UpdateCapacityCommitmentRequest) returns (CapacityCommitment)

Updates an existing capacity commitment.

Only plan and renewal_plan fields can be updated.

Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateReservation

rpc UpdateReservation(UpdateReservationRequest) returns (Reservation)

Updates an existing reservation resource.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Assignment

An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.

Fields
name

string

Output only. Name of the resource. E.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
assignee

string

The resource which will use the reservation. E.g. projects/myproject, folders/123, or organizations/456.
job_type

JobType

Which type of jobs will use the reservation.
state

State

Output only. State of the assignment.

JobType

Types of job, which could be specified when using the reservation.

Enums
JOB_TYPE_UNSPECIFIED Invalid type. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT.
PIPELINE Pipeline (load/export) jobs from the project will use the reservation.
QUERY Query jobs from the project will use the reservation.
ML_EXTERNAL BigQuery ML jobs that use services external to BigQuery for model training. These jobs will not utilize idle slots from other reservations.
BACKGROUND Background jobs that BigQuery runs for the customers in the background.

State

Assignment will remain in PENDING state if no active capacity commitment is present. It will become ACTIVE when some capacity commitment becomes active.

Enums
STATE_UNSPECIFIED Invalid state value.
PENDING Queries from assignee will be executed as on-demand, if related assignment is pending.
ACTIVE Assignment is ready.

BiReservation

Represents a BI Reservation.

Fields
name

string

The resource name of the singleton BI reservation. Reservation names have the form projects/{project_id}/locations/{location_id}/biReservation.
update_time

Timestamp

Output only. The last update timestamp of a reservation.
size

int64

Size of a reservation, in bytes.
preferred_tables[]

TableReference

Preferred tables to use BI capacity for.

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.

Fields
name

string

Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_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.
slot_count

int64

Number of slots in this commitment.
plan

CommitmentPlan

Capacity commitment commitment plan.
state

State

Output only. State of the commitment.
commitment_start_time

Timestamp

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.
commitment_end_time

Timestamp

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,
failure_status

Status

Output only. For FAILED commitment plan, provides the reason of failure.
renewal_plan

CommitmentPlan

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.
edition

Edition

Edition of the capacity commitment.
is_flat_rate

bool

Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.

CommitmentPlan

Commitment plan defines the current committed period. Capacity commitment cannot be deleted during it's committed period.

Enums
COMMITMENT_PLAN_UNSPECIFIED Invalid plan value. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT.
FLEX Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.
FLEX_FLAT_RATE

Same as FLEX, should only be used if flat-rate commitments are still available.
TRIAL

Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the renewal_plan. Default renewal_plan for Trial commitment is Flex so that it can be deleted right after committed period ends.
MONTHLY Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.
MONTHLY_FLAT_RATE

Same as MONTHLY, should only be used if flat-rate commitments are still available.
ANNUAL Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.
ANNUAL_FLAT_RATE

Same as ANNUAL, should only be used if flat-rate commitments are still available.
THREE_YEAR 3-year commitments have a committed period of 1095(3 * 365) days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.
NONE Should only be used for renewal_plan and is only meaningful if edition is specified to values other than EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or UpdateCapacityCommitmentRequest will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. If the renewal_plan is NONE, capacity commitment will be removed at the end of its commitment period.

State

Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE or FAILED.

Enums
STATE_UNSPECIFIED Invalid state value.
PENDING Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the project's slot_capacity.
ACTIVE Once slots are provisioned, capacity commitment becomes active. slot_count is added to the project's slot_capacity.
FAILED Capacity commitment is failed to be activated by the backend.

CreateAssignmentRequest

The request for ReservationService.CreateAssignment. Note: "bigquery.reservationAssignments.create" permission is required on the related assignee.

Fields
parent

string

Required. The parent resource name of the assignment E.g. projects/myproject/locations/US/reservations/team1-prod

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.reservationAssignments.create
assignment

Assignment

Assignment resource to create.
assignment_id

string

The 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.

CreateCapacityCommitmentRequest

The request for ReservationService.CreateCapacityCommitment.

Fields
parent

string

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.capacityCommitments.create
capacity_commitment

CapacityCommitment

Content of the capacity commitment to create.
enforce_single_admin_project_per_org

bool

If true, fail the request if another project in the organization has a capacity commitment.
capacity_commitment_id

string

The 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.

CreateReservationRequest

The request for ReservationService.CreateReservation.

Fields
parent

string

Required. Project, location. E.g., projects/myproject/locations/US

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.reservations.create
reservation_id

string

The 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.
reservation

Reservation

Definition of the new reservation to create.

DeleteAssignmentRequest

The request for ReservationService.DeleteAssignment. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee.

Fields
name

string

Required. Name of the resource, e.g. projects/myproject/locations/US/reservations/team1-prod/assignments/123

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.reservationAssignments.delete

DeleteCapacityCommitmentRequest

The request for ReservationService.DeleteCapacityCommitment.

Fields
name

string

Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.capacityCommitments.delete
force

bool

Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

DeleteReservationRequest

The request for ReservationService.DeleteReservation.

Fields
name

string

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.reservations.delete

Edition

The type of editions. Different features and behaviors are provided to different editions Capacity commitments and reservations are linked to editions.

Enums
EDITION_UNSPECIFIED Default value, which will be treated as ENTERPRISE.
STANDARD Standard edition.
ENTERPRISE Enterprise edition.
ENTERPRISE_PLUS Enterprise Plus edition.

FailoverReservationRequest

The request for ReservationService.FailoverReservation.

Fields
name

string

Required. Resource name of the reservation to failover. E.g., projects/myproject/locations/US/reservations/team1-prod

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.reservations.update

GetBiReservationRequest

A request to get a singleton BI reservation.

Fields
name

string

Required. Name of the requested reservation, for example: projects/{project_id}/locations/{location_id}/biReservation

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.bireservations.get

GetCapacityCommitmentRequest

The request for ReservationService.GetCapacityCommitment.

Fields
name

string

Required. Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.capacityCommitments.get

GetReservationRequest

The request for ReservationService.GetReservation.

Fields
name

string

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.reservations.get

ListAssignmentsRequest

The request for ReservationService.ListAssignments.

Fields
parent

string

Required. The parent resource name e.g.:

projects/myproject/locations/US/reservations/team1-prod

Or:

projects/myproject/locations/US/reservations/-

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.reservationAssignments.list
page_size

int32

The maximum number of items to return per page.
page_token

string

The next_page_token value returned from a previous List request, if any.

ListAssignmentsResponse

The response for ReservationService.ListAssignments.

Fields
assignments[]

Assignment

List of assignments visible to the user.
next_page_token

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

ListCapacityCommitmentsRequest

The request for ReservationService.ListCapacityCommitments.

Fields
parent

string

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.capacityCommitments.list
page_size

int32

The maximum number of items to return.
page_token

string

The next_page_token value returned from a previous List request, if any.

ListCapacityCommitmentsResponse

The response for ReservationService.ListCapacityCommitments.

Fields
capacity_commitments[]

CapacityCommitment

List of capacity commitments visible to the user.
next_page_token

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

ListReservationsRequest

The request for ReservationService.ListReservations.

Fields
parent

string

Required. The parent resource name containing project and location, e.g.: projects/myproject/locations/US

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.reservations.list
page_size

int32

The maximum number of items to return per page.
page_token

string

The next_page_token value returned from a previous List request, if any.

ListReservationsResponse

The response for ReservationService.ListReservations.

Fields
reservations[]

Reservation

List of reservations visible to the user.
next_page_token

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

MergeCapacityCommitmentsRequest

The request for ReservationService.MergeCapacityCommitments.

Fields
parent

string

Parent resource that identifies admin project and location e.g., projects/myproject/locations/us

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.capacityCommitments.update
capacity_commitment_ids[]

string

Ids of capacity commitments to merge. These capacity commitments must exist under admin project and location specified in the parent. ID is the last portion of capacity commitment name e.g., 'abc' for projects/myproject/locations/US/capacityCommitments/abc

MoveAssignmentRequest

The request for 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.

Fields
name

string

Required. The resource name of the assignment, e.g. projects/myproject/locations/US/reservations/team1-prod/assignments/123

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.reservationAssignments.delete
destination_id

string

The new reservation ID, e.g.: projects/myotherproject/locations/US/reservations/team2-prod
assignment_id

string

The optional assignment ID. A new assignment name is generated if this field is empty.

This field can contain only lowercase alphanumeric characters or dashes. Max length is 64 characters.

Reservation

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

Fields
name

string

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.
slot_capacity

int64

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 of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
ignore_idle_slots

bool

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.
autoscale

Autoscale

The configuration parameters for the auto scaling feature.
concurrency

int64

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.
creation_time

Timestamp

Output only. Creation time of the reservation.
update_time

Timestamp

Output only. Last update time of the reservation.
edition

Edition

Edition of the reservation.
primary_location

string

Output only. The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
secondary_location

string

Optional. 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).
original_primary_location

string

Output only. The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.

Autoscale

Auto scaling settings.

Fields
current_slots

int64

Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute)
max_slots

int64

Number of slots to be scaled when needed.

SearchAllAssignmentsRequest

The request for ReservationService.SearchAllAssignments. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

Fields
parent

string

Required. The resource name with location (project name could be the wildcard '-'), e.g.: projects/-/locations/US.

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.reservationAssignments.search
query

string

Please specify resource name as assignee in the query.

Examples:

  • assignee=projects/myproject
  • assignee=folders/123
  • assignee=organizations/456
page_size

int32

The maximum number of items to return per page.
page_token

string

The next_page_token value returned from a previous List request, if any.

SearchAllAssignmentsResponse

The response for ReservationService.SearchAllAssignments.

Fields
assignments[]

Assignment

List of assignments visible to the user.
next_page_token

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

SearchAssignmentsRequest

The request for ReservationService.SearchAssignments. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

Fields
parent

string

Required. The resource name of the admin project(containing project and location), e.g.: projects/myproject/locations/US.

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.reservationAssignments.search
query

string

Please specify resource name as assignee in the query.

Examples:

  • assignee=projects/myproject
  • assignee=folders/123
  • assignee=organizations/456
page_size

int32

The maximum number of items to return per page.
page_token

string

The next_page_token value returned from a previous List request, if any.

SearchAssignmentsResponse

The response for ReservationService.SearchAssignments.

Fields
assignments[]

Assignment

List of assignments visible to the user.
next_page_token

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

SplitCapacityCommitmentRequest

The request for ReservationService.SplitCapacityCommitment.

Fields
name

string

Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.capacityCommitments.update
slot_count

int64

Number of slots in the capacity commitment after the split.

SplitCapacityCommitmentResponse

The response for ReservationService.SplitCapacityCommitment.

Fields
first

CapacityCommitment

First capacity commitment, result of a split.
second

CapacityCommitment

Second capacity commitment, result of a split.

TableReference

Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.

Fields
project_id

string

The assigned project ID of the project.
dataset_id

string

The ID of the dataset in the above project.
table_id

string

The ID of the table in the above dataset.

UpdateAssignmentRequest

The request for ReservationService.UpdateAssignment.

Fields
assignment

Assignment

Content of the assignment to update.

Authorization requires the following IAM permission on the specified resource assignment:

  • bigquery.reservationassignments.update
update_mask

FieldMask

Standard field mask for the set of fields to be updated.

UpdateBiReservationRequest

A request to update a BI reservation.

Fields
bi_reservation

BiReservation

A reservation to update.

Authorization requires the following IAM permission on the specified resource biReservation:

  • bigquery.bireservations.update
update_mask

FieldMask

A list of fields to be updated in this request.

UpdateCapacityCommitmentRequest

The request for ReservationService.UpdateCapacityCommitment.

Fields
capacity_commitment

CapacityCommitment

Content of the capacity commitment to update.

Authorization requires the following IAM permission on the specified resource capacityCommitment:

  • bigquery.capacityCommitments.update
update_mask

FieldMask

Standard field mask for the set of fields to be updated.

UpdateReservationRequest

The request for ReservationService.UpdateReservation.

Fields
reservation

Reservation

Content of the reservation to update.

Authorization requires the following IAM permission on the specified resource reservation:

  • bigquery.reservations.update
update_mask

FieldMask

Standard field mask for the set of fields to be updated.