Namespace Google.Apis.BigQueryReservation.v1beta1
Classes
BigQueryReservationBaseServiceRequest<TResponse>
A base abstract class for BigQueryReservation requests.
BigQueryReservationService
The BigQueryReservation Service.
BigQueryReservationService.Scope
Available OAuth 2.0 scopes for use with the BigQuery Reservation API.
BigQueryReservationService.ScopeConstants
Available OAuth 2.0 scope constants for use with the BigQuery Reservation API.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.CapacityCommitmentsResource
The "capacityCommitments" collection of methods.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.CreateRequest
Creates a new capacity commitment resource.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.DeleteRequest
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
.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.GetRequest
Returns information about the capacity commitment.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.ListRequest
Lists all the capacity commitments for the admin project.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.MergeRequest
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
.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.PatchRequest
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
.
ProjectsResource.LocationsResource.CapacityCommitmentsResource.SplitRequest
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.
ProjectsResource.LocationsResource.GetBiReservationRequest
Retrieves a BI reservation.
ProjectsResource.LocationsResource.ReservationsResource
The "reservations" collection of methods.
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource
The "assignments" collection of methods.
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.CreateRequest
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.
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.DeleteRequest
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:
and
In this example, deletion of theassignment won't affect the other assignment
. After said deletion, queries fromproject1
will still useres1
while queries fromproject2
will switch to use on-demand mode.
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.ListRequest
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: and
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.
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.MoveRequest
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.
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.PatchRequest
Updates an existing assignment. Only the priority
field can be updated.
ProjectsResource.LocationsResource.ReservationsResource.CreateRequest
Creates a new reservation resource.
ProjectsResource.LocationsResource.ReservationsResource.DeleteRequest
Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION
when reservation has
assignments.
ProjectsResource.LocationsResource.ReservationsResource.GetRequest
Returns information about the reservation.
ProjectsResource.LocationsResource.ReservationsResource.ListRequest
Lists all the reservations for the project in the specified location.
ProjectsResource.LocationsResource.ReservationsResource.PatchRequest
Updates an existing reservation resource.
ProjectsResource.LocationsResource.SearchAssignmentsRequest
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.
ProjectsResource.LocationsResource.UpdateBiReservationRequest
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.
Enums
BigQueryReservationBaseServiceRequest<TResponse>.AltEnum
Data format for response.
BigQueryReservationBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.