download method

Future<Object> download(String resourceName, { String? $fields, DownloadOptions downloadOptions = commons.DownloadOptions.metadata, })

Downloads media.

Download is supported on the URI /download/{resource_name=**}?alt=media. Note: Download requests will not be successful without including alt=media query string.

Request parameters:

resourceName - Name of the media that is being downloaded. See ReadRequest.resource_name. Value must have pattern ^.*$.

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

downloadOptions - Options for downloading. A download can be either a Metadata (default) or Media download. Partial Media downloads are possible as well.

Completes with a

• GoogleBytestreamMedia for Metadata downloads (see downloadOptions).

• commons.Media for Media downloads (see downloadOptions).

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<core.Object> download(
  core.String resourceName, {
  core.String? $fields,
  commons.DownloadOptions downloadOptions = commons.DownloadOptions.metadata,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'download/' + core.Uri.encodeFull('$resourceName');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
    downloadOptions: downloadOptions,
  );
  if (downloadOptions.isMetadataDownload) {
    return GoogleBytestreamMedia.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  } else {
    return response_ as commons.Media;
  }
}