list method

Future<ListMonitoredResourceDescriptorsResponse> list(String name, { String? filter, int? pageSize, String? pageToken, String? $fields, })

Lists monitored resource descriptors that match a filter.

Request parameters:

name - Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] Value must have pattern ^projects/\[^/\]+$.

filter - An optional filter (https://cloud.google.com/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id

pageSize - A positive number that is the maximum number of results to return.

pageToken - If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

Completes with a ListMonitoredResourceDescriptorsResponse.

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<ListMonitoredResourceDescriptorsResponse> list(
  core.String name, {
  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_ =
      'v3/' + core.Uri.encodeFull('$name') + '/monitoredResourceDescriptors';

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