googleapis.com – bigqueryreservation
A service to modify your BigQuery flat-rate reservations.
- Homepage
- https://api.apis.guru/v2/specs/googleapis.com:bigqueryreservation/v1.json
- Provider
- googleapis.com:bigqueryreservation / bigqueryreservation
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/googleapis.com/bigqueryreservation/v1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/googleapis.com/bigqueryreservation/v1/openapi.yaml
Tools (16)
Extracted live via the executor SDK.
-
projects.bigqueryreservationProjectsLocationsCapacityCommitmentsCreateCreates a new capacity commitment resource.
-
projects.bigqueryreservationProjectsLocationsCapacityCommitmentsListLists all the capacity commitments for the admin project.
-
projects.bigqueryreservationProjectsLocationsCapacityCommitmentsMergeMerges 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. -
projects.bigqueryreservationProjectsLocationsCapacityCommitmentsSplitSplits 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. -
projects.bigqueryreservationProjectsLocationsReservationsAssignmentsCreateCreates 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
organizationAcontains two projects,project1andproject2. * Assignments for all three entities (organizationA,project1, andproject2) 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. Returnsgoogle.rpc.Code.PERMISSION_DENIEDif user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returnsgoogle.rpc.Code.INVALID_ARGUMENTwhen location of the assignment does not match location of the reservation. -
projects.bigqueryreservationProjectsLocationsReservationsAssignmentsDeleteDeletes a assignment. No expansion will happen. Example: * Organization
organizationAcontains two projects,project1andproject2. * Reservationres1exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations:andIn this example, deletion of theassignment won't affect the other assignment. After said deletion, queries fromproject1will still useres1while queries fromproject2will switch to use on-demand mode. -
projects.bigqueryreservationProjectsLocationsReservationsAssignmentsListLists assignments. Only explicitly created assignments will be returned. Example: * Organization
organizationAcontains two projects,project1andproject2. * Reservationres1exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations:andIn this example, ListAssignments will just return the above two assignments for reservationres1, 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. -
projects.bigqueryreservationProjectsLocationsReservationsAssignmentsMoveMoves 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.
-
projects.bigqueryreservationProjectsLocationsReservationsAssignmentsPatchUpdates an existing assignment. Only the
priorityfield can be updated. -
projects.bigqueryreservationProjectsLocationsReservationsCreateCreates a new reservation resource.
-
projects.bigqueryreservationProjectsLocationsReservationsGetReturns information about the reservation.
-
projects.bigqueryreservationProjectsLocationsReservationsListLists all the reservations for the project in the specified location.
-
projects.bigqueryreservationProjectsLocationsSearchAllAssignmentsLooks 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 ofprojects/*/locations/*reservations/*. -
projects.bigqueryreservationProjectsLocationsSearchAssignmentsDeprecated: 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 ofprojects/*/locations/*reservations/*. Note "-" cannot be used for projects nor locations. -
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools