Cloud Desktop API, REST: DesktopImage.List

Field

Description

folderId

string

Required field. ID of the folder to list desktop images in.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a [ListDesktopImagesRequest.next_page_token]
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
[ListDesktopImagesRequest.next_page_token] returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

1. The field name. Currently you can use filtering only on DesktopImage.name field.
2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
3. Value or a list of values to compare against the values of the field.

orderBy

string

Sorting the list by DesktopImage.name, DesktopImage.createdAt and DesktopImage.status fields.
The default sorting order is ascending.

Field

Description

desktopImages[]

DesktopImage

List of desktop images.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListDesktopImagesRequest.pageSize, use
the nextPageToken as the value
for the ListDesktopImagesRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Field

Description

id

string

ID of the image.

folderId

string

ID of the folder that the image belongs to.

createdAt

string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

status

enum (Status)

Status of the image.

• STATUS_UNSPECIFIED
• CREATING: Image is being created.
• ACTIVE: Image is ready to use.
• DELETING: Image is being deleted.

name

string

Name of the image.

labels

string

Description of the image.

storageSize

string (int64)

Size of the image, specified in bytes.

minDiskSize

string (int64)

Minimum disk size in bytes required to use the image.