reservation_blocks
Creates, updates, deletes, gets or lists a reservation_blocks
resource.
Overview
Name | reservation_blocks |
Type | Resource |
Id | google.compute.reservation_blocks |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Successful response
Name | Datatype | Description |
---|---|---|
resource | object | Represents a reservation block resource. (id: ReservationBlock) |
Successful response
Name | Datatype | Description |
---|---|---|
id | string | Unique identifier for the resource; defined by the server. |
items | array | A list of reservation block resources. |
kind | string | Type of the resource. Always compute#reservationBlock for a list of reservation blocks. (default: compute#reservationBlock) |
nextPageToken | string | This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
selfLink | string | Server-defined URL for this resource. |
warning | object | Informational warning message. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | project , zone , reservation , reservationBlock | view | Retrieves information about the specified reservation block. |
list | select | project , zone , reservation | filter , maxResults , orderBy , pageToken , returnPartialSuccess | Retrieves a list of reservation blocks under a single reservation. |
perform_maintenance | exec | project , zone , reservation , reservationBlock | requestId | Allows customers to perform maintenance on a reservation block |
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 |
---|---|---|
project | string | |
reservation | string | |
reservationBlock | string | |
zone | string | |
filter | string | |
maxResults | integer (uint32) | |
orderBy | string | |
pageToken | string | |
requestId | string | |
returnPartialSuccess | boolean | |
view | string |
SELECT
examples
- get
- list
Retrieves information about the specified reservation block.
SELECT
resource
FROM google.compute.reservation_blocks
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND reservation = '{{ reservation }}' -- required
AND reservationBlock = '{{ reservationBlock }}' -- required
AND view = '{{ view }}';
Retrieves a list of reservation blocks under a single reservation.
SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.reservation_blocks
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND reservation = '{{ reservation }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';
Lifecycle Methods
- perform_maintenance
Allows customers to perform maintenance on a reservation block
EXEC google.compute.reservation_blocks.perform_maintenance
@project='{{ project }}' --required,
@zone='{{ zone }}' --required,
@reservation='{{ reservation }}' --required,
@reservationBlock='{{ reservationBlock }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"maintenanceScope": "{{ maintenanceScope }}"
}';