queued_resources

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

Overview

Name	queued_resources
Type	Resource
Id	google.tpu.queued_resources

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Immutable. The name of the QueuedResource.
createTime	string (google-datetime)	Output only. The time when the QueuedResource was created.
guaranteed	object	Optional. The Guaranteed tier (id: Guaranteed)
queueingPolicy	object	Optional. The queueing policy of the QueuedRequest. (id: QueueingPolicy)
reservationName	string	Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
spot	object	Optional. The Spot tier. (id: Spot)
state	object	Output only. State of the QueuedResource request. (id: QueuedResourceState)
tpu	object	Optional. Defines a TPU resource. (id: Tpu)

list

Successful response

Name	Datatype	Description
name	string	Output only. Immutable. The name of the QueuedResource.
createTime	string (google-datetime)	Output only. The time when the QueuedResource was created.
guaranteed	object	Optional. The Guaranteed tier (id: Guaranteed)
queueingPolicy	object	Optional. The queueing policy of the QueuedRequest. (id: QueueingPolicy)
reservationName	string	Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
spot	object	Optional. The Spot tier. (id: Spot)
state	object	Output only. State of the QueuedResource request. (id: QueuedResourceState)
tpu	object	Optional. Defines a TPU resource. (id: Tpu)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, queuedResourcesId		Gets details of a queued resource.
list	select	projectsId, locationsId	pageSize, pageToken	Lists queued resources.
create	insert	projectsId, locationsId	queuedResourceId, requestId	Creates a QueuedResource TPU instance.
delete	delete	projectsId, locationsId, queuedResourcesId	requestId, force	Deletes a QueuedResource TPU instance.
reset	exec	projectsId, locationsId, queuedResourcesId		Resets a QueuedResource TPU instance

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
queuedResourcesId	string
force	boolean
pageSize	integer (int32)
pageToken	string
queuedResourceId	string
requestId	string

SELECT examples

get

Gets details of a queued resource.

SELECT
name,
createTime,
guaranteed,
queueingPolicy,
reservationName,
spot,
state,
tpu
FROM google.tpu.queued_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND queuedResourcesId = '{{ queuedResourcesId }}' -- required;

list

Lists queued resources.

SELECT
name,
createTime,
guaranteed,
queueingPolicy,
reservationName,
spot,
state,
tpu
FROM google.tpu.queued_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a QueuedResource TPU instance.

INSERT INTO google.tpu.queued_resources (
data__tpu,
data__spot,
data__guaranteed,
data__queueingPolicy,
data__reservationName,
projectsId,
locationsId,
queuedResourceId,
requestId
)
SELECT 
'{{ tpu }}',
'{{ spot }}',
'{{ guaranteed }}',
'{{ queueingPolicy }}',
'{{ reservationName }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ queuedResourceId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: queued_resources
  props:
    - name: projectsId
      value: string
      description: Required parameter for the queued_resources resource.
    - name: locationsId
      value: string
      description: Required parameter for the queued_resources resource.
    - name: tpu
      value: object
      description: >
        Optional. Defines a TPU resource.
        
    - name: spot
      value: object
      description: >
        Optional. The Spot tier.
        
    - name: guaranteed
      value: object
      description: >
        Optional. The Guaranteed tier
        
    - name: queueingPolicy
      value: object
      description: >
        Optional. The queueing policy of the QueuedRequest.
        
    - name: reservationName
      value: string
      description: >
        Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
        
    - name: queuedResourceId
      value: string
    - name: requestId
      value: string

DELETE examples

delete

Deletes a QueuedResource TPU instance.

DELETE FROM google.tpu.queued_resources
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND queuedResourcesId = '{{ queuedResourcesId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}';

Lifecycle Methods

reset

Resets a QueuedResource TPU instance

EXEC google.tpu.queued_resources.reset 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@queuedResourcesId='{{ queuedResourcesId }}' --required;