reservation_groups

Creates, updates, deletes, gets or lists a reservation_groups resource.

Overview

Name	reservation_groups
Type	Resource
Id	google.bigqueryreservation.reservation_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the reservation group, e.g., projects/*/locations/*/reservationGroups/team1-prod. The reservation_group_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.
parentGroup	string	Optional. The parent reservation group of the reservation group. Format: projects/*/locations/*/reservationGroups/team1-prod for non-root reservation groups, or projects/*/locations/* for root reservation groups.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the reservation group, e.g., projects/*/locations/*/reservationGroups/team1-prod. The reservation_group_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.
parentGroup	string	Optional. The parent reservation group of the reservation group. Format: projects/*/locations/*/reservationGroups/team1-prod for non-root reservation groups, or projects/*/locations/* for root reservation groups.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, reservationGroupsId		Returns information about the reservation group.
list	select	projectsId, locationsId	pageToken, pageSize	Lists all the reservation groups for the project in the specified location.
create	insert	projectsId, locationsId	reservationGroupId	Creates a new reservation group.
patch	update	projectsId, locationsId, reservationGroupsId	updateMask	Updates an existing reservation group resource.
delete	delete	projectsId, locationsId, reservationGroupsId		Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
reservationGroupsId	string
pageSize	integer (int32)
pageToken	string
reservationGroupId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns information about the reservation group.

SELECT
name,
parentGroup
FROM google.bigqueryreservation.reservation_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reservationGroupsId = '{{ reservationGroupsId }}' -- required
;

list

Lists all the reservation groups for the project in the specified location.

SELECT
name,
parentGroup
FROM google.bigqueryreservation.reservation_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Creates a new reservation group.

INSERT INTO google.bigqueryreservation.reservation_groups (
data__name,
data__parentGroup,
projectsId,
locationsId,
reservationGroupId
)
SELECT 
'{{ name }}',
'{{ parentGroup }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ reservationGroupId }}'
RETURNING
name,
parentGroup
;

Manifest

# Description fields are for documentation purposes
- name: reservation_groups
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the reservation_groups resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the reservation_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_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.
  - name: parentGroup
    value: "{{ parentGroup }}"
    description: |
      Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups.
  - name: reservationGroupId
    value: "{{ reservationGroupId }}"

UPDATE examples

patch

Updates an existing reservation group resource.

UPDATE google.bigqueryreservation.reservation_groups
SET 
data__name = '{{ name }}',
data__parentGroup = '{{ parentGroup }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND reservationGroupsId = '{{ reservationGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
parentGroup;

DELETE examples

delete

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

DELETE FROM google.bigqueryreservation.reservation_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND reservationGroupsId = '{{ reservationGroupsId }}' --required
;