list method
Lists metric 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
- If this field is empty, all custom and system-defined metric
descriptors are returned. Otherwise, the filter
(https://cloud.google.com/monitoring/api/v3/filters) specifies which
metric descriptors are to be returned. For example, the following filter
matches all custom metrics
(https://cloud.google.com/monitoring/custom-metrics): metric.type =
starts_with("custom.googleapis.com/")
pageSize
- A positive number that is the maximum number of results to
return. The default and maximum value is 10,000. If a page_size <= 0 or
> 10,000 is submitted, will instead return a maximum of 10,000 results.
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 ListMetricDescriptorsResponse.
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<ListMetricDescriptorsResponse> 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') + '/metricDescriptors';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListMetricDescriptorsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}