list method

Future<ListAssetsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? orderBy,
  4. int? pageSize,
  5. String? pageToken,
  6. bool? showHidden,
  7. String? view,
  8. String? $fields,
})

Lists all the assets in a given project and location.

Request parameters:

parent - Required. Parent value for ListAssetsRequest. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Filtering results.

orderBy - Field to sort by. See https://google.aip.dev/132#ordering for more details.

pageSize - Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken - A token identifying a page of results the server should return.

showHidden - Optional. When this value is set to 'true,' the response will include all assets, including those that are hidden.

view - View of the assets. Defaults to BASIC. Possible string values are:

  • "ASSET_VIEW_UNSPECIFIED" : The asset view is not specified. The API displays the basic view by default.
  • "ASSET_VIEW_BASIC" : The asset view includes only basic metadata of the asset.
  • "ASSET_VIEW_FULL" : The asset view includes all the metadata of an asset and performance data.
  • "ASSET_VIEW_STANDARD" : The asset view includes the standard metadata of an asset.
  • "ASSET_VIEW_UI" : The asset view includes fields needed by UI.
  • "ASSET_VIEW_LABELS" : The asset view includes asset name and labels.

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

Completes with a ListAssetsResponse.

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<ListAssetsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? showHidden,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (showHidden != null) 'showHidden': ['${showHidden}'],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/assets';

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