2022-10-28
▼ ▲ bigqueryreservation.projects.locations.getBiReservation
Parameter Order: name
Scopes:
Path: v1beta1/{+name}
Description: Retrieves a BI reservation.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/biReservation
HTTP Method: GET
Parameters:
name
Description: Required. Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/biReservation`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/biReservation$
Location: path
▼ ▲ bigqueryreservation.projects.locations.updateBiReservation
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/biReservation
Description: 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.
Parameters:
updateMask
Description: A list of fields to be updated in this request.
Type: string
Format: google-fieldmask
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/biReservation$
Type: string
Required: Yes
Location: path
Description: The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.
Scopes:
HTTP Method: PATCH
▼ ▲ bigqueryreservation.projects.locations.searchAssignments
Path: v1beta1/{+parent}:searchAssignments
Parameters:
pageSize
Format: int32
Location: query
Description: The maximum number of items to return.
Type: integer
pageToken
Type: string
Location: query
Description: The next_page_token value returned from a previous List request, if any.
query
Type: string
Location: query
Description: Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the admin project(containing project and location), e.g.: `projects/myproject/locations/US`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}:searchAssignments
Scopes:
Parameter Order: parent
Description: 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.
HTTP Method: GET
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.patch
HTTP Method: PATCH
Scopes:
Parameters:
name
Type: string
Description: 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.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$
updateMask
Type: string
Description: Standard field mask for the set of fields to be updated.
Location: query
Format: google-fieldmask
Description: 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`.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}
Path: v1beta1/{+name}
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.create
Path: v1beta1/{+parent}/capacityCommitments
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Description: Required. Resource name of the parent reservation. E.g., `projects/myproject/locations/US`
enforceSingleAdminProjectPerOrg
Type: boolean
Location: query
Description: If true, fail the request if another project in the organization has a capacity commitment.
capacityCommitmentId
Description: 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.
Type: string
Location: query
HTTP Method: POST
Parameter Order: parent
Description: Creates a new capacity commitment resource.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments
Scopes:
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.get
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$
Description: Required. Resource name of the capacity commitment to retrieve. E.g., `projects/myproject/locations/US/capacityCommitments/123`
Location: path
Required: Yes
HTTP Method: GET
Parameter Order: name
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}
Scopes:
Description: Returns information about the capacity commitment.
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.delete
Scopes:
HTTP Method: DELETE
Description: 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`.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$
Required: Yes
Type: string
Description: Required. Resource name of the capacity commitment to delete. E.g., `projects/myproject/locations/US/capacityCommitments/123`
Location: path
force
Location: query
Description: 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.
Type: boolean
Parameter Order: name
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.list
HTTP Method: GET
Description: Lists all the capacity commitments for the admin project.
Scopes:
Parameters:
pageToken
Location: query
Type: string
Description: The next_page_token value returned from a previous List request, if any.
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Resource name of the parent reservation. E.g., `projects/myproject/locations/US`
pageSize
Location: query
Description: The maximum number of items to return.
Format: int32
Type: integer
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments
Path: v1beta1/{+parent}/capacityCommitments
Parameter Order: parent
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.merge
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments:merge
Scopes:
Path: v1beta1/{+parent}/capacityCommitments:merge
HTTP Method: POST
Description: 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`.
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Parent resource that identifies admin project and location e.g., `projects/myproject/locations/us`
Parameter Order: parent
▼ ▲ bigqueryreservation.projects.locations.capacityCommitments.split
HTTP Method: POST
Description: 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.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$
Description: Required. The resource name e.g.,: `projects/myproject/locations/US/capacityCommitments/123`
Type: string
Location: path
Required: Yes
Path: v1beta1/{+name}:split
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}:split
Parameter Order: name
Scopes:
▼ ▲ bigqueryreservation.projects.locations.reservations.patch
Scopes:
Path: v1beta1/{+name}
HTTP Method: PATCH
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+$
Description: 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.
Location: path
Required: Yes
updateMask
Description: Standard field mask for the set of fields to be updated.
Location: query
Type: string
Format: google-fieldmask
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}
Description: Updates an existing reservation resource.
Parameter Order: name
▼ ▲ bigqueryreservation.projects.locations.reservations.create
Parameter Order: parent
HTTP Method: POST
Description: Creates a new reservation resource.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations
Path: v1beta1/{+parent}/reservations
Scopes:
Parameters:
reservationId
Location: query
Description: 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.
Type: string
parent
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Project, location. E.g., `projects/myproject/locations/US`
▼ ▲ bigqueryreservation.projects.locations.reservations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}
HTTP Method: GET
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+$
Location: path
Description: Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod`
Scopes:
Description: Returns information about the reservation.
Parameter Order: name
Path: v1beta1/{+name}
▼ ▲ bigqueryreservation.projects.locations.reservations.delete
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}
HTTP Method: DELETE
Description: Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.
Path: v1beta1/{+name}
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+$
Location: path
Description: Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod`
Scopes:
▼ ▲ bigqueryreservation.projects.locations.reservations.list
Path: v1beta1/{+parent}/reservations
Parameter Order: parent
Scopes:
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations
HTTP Method: GET
Parameters:
filter
Description: Can be used to filter out reservations based on names, capacity, etc, e.g.: filter="reservation.slot_capacity > 200" filter="reservation.name = \"*dev/*\"" Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/view/advanced-filters).
Location: query
Type: string
pageToken
Description: The next_page_token value returned from a previous List request, if any.
Type: string
Location: query
pageSize
Description: The maximum number of items to return.
Location: query
Type: integer
Format: int32
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource name containing project and location, e.g.: `projects/myproject/locations/US`
Required: Yes
Type: string
Location: path
Description: Lists all the reservations for the project in the specified location.
▼ ▲ bigqueryreservation.projects.locations.reservations.assignments.delete
Scopes:
Description: 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 the `` assignment won't affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}
Parameter Order: name
HTTP Method: DELETE
Path: v1beta1/{+name}
Parameters:
name
Required: Yes
Location: path
Description: Required. Name of the resource, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$
▼ ▲ bigqueryreservation.projects.locations.reservations.assignments.list
Parameter Order: parent
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments
Parameters:
parent
Type: string
Location: path
Description: Required. The parent resource name e.g.: `projects/myproject/locations/US/reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-`
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+$
Required: Yes
pageToken
Location: query
Type: string
Description: The next_page_token value returned from a previous List request, if any.
pageSize
Format: int32
Description: The maximum number of items to return.
Location: query
Type: integer
Description: 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.
Path: v1beta1/{+parent}/assignments
Scopes:
▼ ▲ bigqueryreservation.projects.locations.reservations.assignments.create
Path: v1beta1/{+parent}/assignments
HTTP Method: POST
Scopes:
Description: 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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+$
Required: Yes
Description: Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod`
Type: string
assignmentId
Description: 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.
Location: query
Type: string
Parameter Order: parent
▼ ▲ bigqueryreservation.projects.locations.reservations.assignments.patch
HTTP Method: PATCH
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}
Path: v1beta1/{+name}
Parameters:
name
Location: path
Description: 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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$
Required: Yes
updateMask
Description: Standard field mask for the set of fields to be updated.
Format: google-fieldmask
Location: query
Type: string
Description: Updates an existing assignment. Only the `priority` field can be updated.
Scopes:
Parameter Order: name
▼ ▲ bigqueryreservation.projects.locations.reservations.assignments.move
Scopes:
Description: 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.
Path: v1beta1/{+name}:move
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}:move
HTTP Method: POST
Parameter Order: name
Parameters:
name
Type: string
Description: Required. The resource name of the assignment, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$