checkValidCreds method

Future<CheckValidCredsResponse> checkValidCreds (
  1. CheckValidCredsRequest request,
  2. String name,
  3. {String $fields}
)

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

request - The metadata request object.

Request parameters:

name - Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}. Value must have pattern "^projects/^/+/locations/^/+/dataSources/^/+$".

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

Completes with a CheckValidCredsResponse.

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<CheckValidCredsResponse> checkValidCreds(
    CheckValidCredsRequest request, core.String name,
    {core.String $fields}) {
  var _url;
  var _queryParams = new core.Map<core.String, core.List<core.String>>();
  var _uploadMedia;
  var _uploadOptions;
  var _downloadOptions = commons.DownloadOptions.Metadata;
  var _body;

  if (request != null) {
    _body = convert.json.encode((request).toJson());
  }
  if (name == null) {
    throw new core.ArgumentError("Parameter name is required.");
  }
  if ($fields != null) {
    _queryParams["fields"] = [$fields];
  }

  _url = 'v1/' +
      commons.Escaper.ecapeVariableReserved('$name') +
      ':checkValidCreds';

  var _response = _requester.request(_url, "POST",
      body: _body,
      queryParams: _queryParams,
      uploadOptions: _uploadOptions,
      uploadMedia: _uploadMedia,
      downloadOptions: _downloadOptions);
  return _response.then((data) => new CheckValidCredsResponse.fromJson(data));
}