accelerator_types

Creates, updates, deletes, gets or lists an accelerator_types resource.

Overview

Name	accelerator_types
Type	Resource
Id	google.compute.accelerator_types

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	[Output Only] Name of the resource. (pattern: a-z?)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
deprecated	object	[Output Only] The deprecation status associated with this accelerator type. (id: DeprecationStatus)
description	string	[Output Only] An optional textual description of the resource.
kind	string	[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. (default: compute#acceleratorType)
maximumCardsPerInstance	integer (int32)	[Output Only] Maximum number of accelerator cards allowed per instance.
selfLink	string	[Output Only] Server-defined, fully qualified URL for this resource.
zone	string	[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of AcceleratorType resources.
kind	string	[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. (default: compute#acceleratorTypeList)
nextPageToken	string	[Output Only] 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	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	[Output Only] Name of the resource. (pattern: a-z?)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
deprecated	object	[Output Only] The deprecation status associated with this accelerator type. (id: DeprecationStatus)
description	string	[Output Only] An optional textual description of the resource.
kind	string	[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. (default: compute#acceleratorType)
maximumCardsPerInstance	integer (int32)	[Output Only] Maximum number of accelerator cards allowed per instance.
selfLink	string	[Output Only] Server-defined, fully qualified URL for this resource.
zone	string	[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, zone, acceleratorType		Returns the specified accelerator type.
list	select	project, zone	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of accelerator types that are available to the specified project.
aggregated_list	select	project	filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber	Retrieves an aggregated list of accelerator types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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
acceleratorType	string
project	string
zone	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified accelerator type.

SELECT
id,
name,
creationTimestamp,
deprecated,
description,
kind,
maximumCardsPerInstance,
selfLink,
zone
FROM google.compute.accelerator_types
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND acceleratorType = '{{ acceleratorType }}' -- required;

list

Retrieves a list of accelerator types that are available to the specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.accelerator_types
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

aggregated_list

Retrieves an aggregated list of accelerator types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
deprecated,
description,
kind,
maximumCardsPerInstance,
selfLink,
zone
FROM google.compute.accelerator_types
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';