IoT Core Service, gRPC: RegistryService.ListDeviceTopicAliases

Field

Description

registryId

string

Required field. ID of the registry to list aliases for device topic.

To get a registry ID make a RegistryService.List request.

pageSize

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size, the service returns a ListDeviceTopicAliasesResponse.nextPageToken
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 page_token to the
ListDeviceTopicAliasesResponse.nextPageToken returned by a previous list request.

Field

Description

aliases[]

DeviceAlias

List of device aliases for the specified registry.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListDeviceTopicAliasesRequest.pageSize, use next_page_token as the value
for the ListDeviceTopicAliasesRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Field

Description

deviceId

string

ID of the device that the alias belongs to.

topicPrefix

string

Prefix of a canonical topic name to be aliased, e.g. $devices/abcdef.

alias

string

Alias of a device topic.