get method

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

Gets the details of an error frame.

Request parameters:

name - Required. The name of the frame to retrieve. Format: projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/sources/\[^/\]+/errorFrames/\[^/\]+$.

view - Optional. An optional view mode to control the level of details for the 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 ErrorFrame.

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<ErrorFrame> 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 ErrorFrame.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}