list method

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

Lists all error frames in a given source and location.

Request parameters:

parent - Required. Parent value (the source) for ListErrorFramesRequest. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/sources/\[^/\]+$.

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.

view - Optional. An optional view mode to control the level of details of each error frame. The default is a BASIC frame view. Possible string values are:

  • "ERROR_FRAME_VIEW_UNSPECIFIED" : Value is unset. The system will fallback to the default value.
  • "ERROR_FRAME_VIEW_BASIC" : Include basic frame data, but not the full contents.
  • "ERROR_FRAME_VIEW_FULL" : Include everything.

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

Completes with a ListErrorFramesResponse.

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

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

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