list method

Future<SasPortalListDevicesResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Lists devices under a node or customer.

Request parameters:

parent - Required. The name of the parent resource. Value must have pattern ^nodes/\[^/\]+/deployments/\[^/\]+$.

filter - The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial number of the device. The filter is case insensitive.

pageSize - The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].

pageToken - A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from.

$fields - Selector specifying which fields to include in a partial response.

Completes with a SasPortalListDevicesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<SasPortalListDevicesResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1alpha1/' + core.Uri.encodeFull('$parent') + '/devices';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return SasPortalListDevicesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}