disk_types

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

Overview

Name	disk_types
Type	Resource
Id	google.compute.disk_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.
defaultDiskSizeGb	string (int64)	[Output Only] Server-defined default disk size in GB.
deprecated	object	[Output Only] The deprecation status associated with this disk type. (id: DeprecationStatus)
description	string	[Output Only] An optional description of this resource.
kind	string	[Output Only] Type of the resource. Always compute#diskType for disk types. (default: compute#diskType)
region	string	[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	[Output Only] Server-defined URL for the resource.
validDiskSize	string	[Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
zone	string	[Output Only] URL of the zone where the disk type resides. 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 DiskType resources.
kind	string	[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. (default: compute#regionDiskTypeList)
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.
defaultDiskSizeGb	string (int64)	[Output Only] Server-defined default disk size in GB.
deprecated	object	[Output Only] The deprecation status associated with this disk type. (id: DeprecationStatus)
description	string	[Output Only] An optional description of this resource.
kind	string	[Output Only] Type of the resource. Always compute#diskType for disk types. (default: compute#diskType)
region	string	[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	[Output Only] Server-defined URL for the resource.
validDiskSize	string	[Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
zone	string	[Output Only] URL of the zone where the disk type resides. 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, region, diskType		Returns the specified regional disk type.
list	select	project, region	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of regional disk types available to the specified project.
aggregated_list	select	project	filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber	Retrieves an aggregated list of disk 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
diskType	string
project	string
region	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified regional disk type.

SELECT
id,
name,
creationTimestamp,
defaultDiskSizeGb,
deprecated,
description,
kind,
region,
selfLink,
validDiskSize,
zone
FROM google.compute.disk_types
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND diskType = '{{ diskType }}' -- required;

list

Retrieves a list of regional disk types available to the specified project.

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

aggregated_list

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

SELECT
id,
name,
creationTimestamp,
defaultDiskSizeGb,
deprecated,
description,
kind,
region,
selfLink,
validDiskSize,
zone
FROM google.compute.disk_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 }}';