get method

Future<Report> get(
  1. String name, {
  2. String? view,
  3. String? $fields,
})

Gets details of a single Report.

Request parameters:

name - Required. Name of the resource. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/reportConfigs/\[^/\]+/reports/\[^/\]+$.

view - Determines what information to retrieve for the Report. Possible string values are:

  • "REPORT_VIEW_UNSPECIFIED" : The report view is not specified. The API displays the basic view by default.
  • "REPORT_VIEW_BASIC" : The report view includes only basic metadata of the Report. Useful for list views.
  • "REPORT_VIEW_FULL" : The report view includes all the metadata of the Report. Useful for preview.
  • "REPORT_VIEW_STANDARD" : The report view includes the standard metadata of an report. Useful for detail view.

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

Completes with a Report.

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<Report> get(
  core.String name, {
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

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

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